{ "info": { "_postman_id": "93041416-673f-402c-b182-7c1123f7a400", "name": "RingCentral Adaptive Cards Internal Contacts API", "description": "RingCentral API specification\n\nContact Support:\n Name: RingCentral Developers Support", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T02:49:41.000Z", "updatedAt": "2026-07-28T02:49:42.000Z", "lastUpdatedBy": "35240", "uid": "35240-93041416-673f-402c-b182-7c1123f7a400" }, "item": [ { "name": "restapi", "item": [ { "name": "v1.0", "item": [ { "name": "account", "item": [ { "name": "{accountId}", "item": [ { "name": "directory", "item": [ { "name": "entries", "item": [ { "name": "{entryId}", "item": [ { "name": "Get Corporate Directory Entry", "id": "71d46cfd-a134-4345-84db-71024816e7e3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/directory/entries/:entryId", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "directory", "entries", ":entryId" ], "variable": [ { "id": "87b2b216-272f-4839-b070-6388177ec92c", "key": "accountId", "value": "~", "description": "(Required) Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "id": "45592228-3db8-40b0-8809-73c4044cc56d", "key": "entryId", "value": "", "description": "(Required) Internal identifier of extension to read information for" } ] }, "description": "Returns contact information on a particular corporate user of a federated account." }, "response": [ { "id": "d037d96c-314f-4c47-9a89-da8f04a46f09", "name": "Contact information for given parameters. If value doesn't found then empty body will be returned", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/directory/entries/:entryId", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "directory", "entries", ":entryId" ], "variable": [ { "key": "accountId" }, { "key": "entryId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"type\": \"GroupCallPickup\",\n \"status\": \"Disabled\",\n \"account\": {\n \"id\": \"\",\n \"companyName\": \"\",\n \"federatedName\": \"\",\n \"mainNumber\": {\n \"formattedPhoneNumber\": \"\",\n \"phoneNumber\": \"\",\n \"type\": \"\",\n \"label\": \"\",\n \"usageType\": \"DirectNumber\",\n \"hidden\": \"\",\n \"primary\": \"\"\n }\n },\n \"department\": \"\",\n \"email\": \"\",\n \"extensionNumber\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"name\": \"\",\n \"jobTitle\": \"\",\n \"phoneNumbers\": [\n {\n \"formattedPhoneNumber\": \"\",\n \"phoneNumber\": \"\",\n \"type\": \"\",\n \"label\": \"\",\n \"usageType\": \"ForwardedNumber\",\n \"hidden\": \"\",\n \"primary\": \"\"\n },\n {\n \"formattedPhoneNumber\": \"\",\n \"phoneNumber\": \"\",\n \"type\": \"\",\n \"label\": \"\",\n \"usageType\": \"MobileNumber\",\n \"hidden\": \"\",\n \"primary\": \"\"\n }\n ],\n \"profileImage\": {\n \"etag\": \"\",\n \"uri\": \"\"\n },\n \"site\": {\n \"id\": \"\",\n \"name\": \"\",\n \"code\": \"\"\n },\n \"hidden\": \"\",\n \"role\": {\n \"id\": \"\",\n \"name\": \"\",\n \"domain\": \"\",\n \"displayName\": \"\"\n },\n \"callQueues\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"customFields\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"groups\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"costCenter\": {\n \"id\": \"\",\n \"code\": \"\",\n \"name\": \"\"\n },\n \"integration\": {\n \"id\": \"\",\n \"typeId\": \"\",\n \"type\": \"\",\n \"displayName\": \"\",\n \"routingType\": \"\",\n \"outboundEdgeId\": \"\"\n },\n \"subType\": \"Emergency\"\n}", "createdAt": "2026-07-28T02:49:42.000Z", "updatedAt": "2026-07-28T02:49:42.000Z", "uid": "35240-d037d96c-314f-4c47-9a89-da8f04a46f09" }, { "id": "e721dc18-942c-47ae-95ab-be599a9faa97", "name": "Current request cannot be processed due to error in its body and/or url", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/directory/entries/:entryId", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "directory", "entries", ":entryId" ], "variable": [ { "key": "accountId" }, { "key": "entryId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"ErrorCode{code='ADG-121', httpStatus=400, description='Parameter [${paramName}] is invalid. ${additionalInfo:-}'}\",\n \"message\": \"\"\n },\n {\n \"errorCode\": \"ErrorCode{code='ADG-102', httpStatus=405, description='Method not allowed.'}\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:49:42.000Z", "updatedAt": "2026-07-28T02:49:42.000Z", "uid": "35240-e721dc18-942c-47ae-95ab-be599a9faa97" }, { "id": "215ec7d3-8b61-4646-9405-5bf15ef2fac2", "name": "Some unexpected error during current request processing", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/directory/entries/:entryId", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "directory", "entries", ":entryId" ], "variable": [ { "key": "accountId" }, { "key": "entryId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"ErrorCode{code='ADG-121', httpStatus=400, description='Parameter [${paramName}] is invalid. ${additionalInfo:-}'}\",\n \"message\": \"\"\n },\n {\n \"errorCode\": \"ErrorCode{code='ADG-102', httpStatus=405, description='Method not allowed.'}\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:49:42.000Z", "updatedAt": "2026-07-28T02:49:42.000Z", "uid": "35240-215ec7d3-8b61-4646-9405-5bf15ef2fac2" }, { "id": "e9f16dee-3f27-4b1a-9641-dc35873333fc", "name": "Network error during request. One should check connection between ADG processing node and ADX data node", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/directory/entries/:entryId", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "directory", "entries", ":entryId" ], "variable": [ { "key": "accountId" }, { "key": "entryId" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"ErrorCode{code='ADG-121', httpStatus=400, description='Parameter [${paramName}] is invalid. ${additionalInfo:-}'}\",\n \"message\": \"\"\n },\n {\n \"errorCode\": \"ErrorCode{code='ADG-102', httpStatus=405, description='Method not allowed.'}\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:49:42.000Z", "updatedAt": "2026-07-28T02:49:42.000Z", "uid": "35240-e9f16dee-3f27-4b1a-9641-dc35873333fc" } ], "createdAt": "2026-07-28T02:49:42.000Z", "updatedAt": "2026-07-28T02:49:42.000Z", "uid": "35240-71d46cfd-a134-4345-84db-71024816e7e3" } ], "id": "a5474bee-f035-4d73-936f-d0dd94ba82bc", "createdAt": "2026-07-28T02:49:42.000Z", "updatedAt": "2026-07-28T02:49:42.000Z", "uid": "35240-a5474bee-f035-4d73-936f-d0dd94ba82bc" }, { "name": "search", "item": [ { "name": "Search Company Directory Entries", "id": "6c1b3ade-76fb-43cf-996c-7f31f7e4a86b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"searchString\": \"\",\n \"searchFields\": [\n \"department\",\n \"firstName\"\n ],\n \"showFederated\": \"\",\n \"showAdminOnlyContacts\": false,\n \"extensionType\": \"Announcement\",\n \"siteId\": \"\",\n \"showExternalContacts\": false,\n \"accountIds\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"siteIds\": [\n \"\",\n \"\"\n ],\n \"extensionStatuses\": [\n \"Enabled\",\n \"NotActivated\"\n ],\n \"extensionTypes\": [\n \"Department\",\n \"Announcement\"\n ],\n \"orderBy\": [\n {\n \"index\": 1,\n \"fieldName\": \"email\",\n \"direction\": \"Asc\"\n },\n {\n \"index\": 1,\n \"fieldName\": \"lastName\",\n \"direction\": \"Asc\"\n }\n ],\n \"page\": \"\",\n \"perPage\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/directory/entries/search?accountId=&department=&siteId=&extensionStatus=&extensionType=Room", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "directory", "entries", "search" ], "query": [ { "description": "A list of Account IDs", "key": "accountId", "value": "" }, { "description": "A list of department names", "key": "department", "value": "" }, { "description": "A list of Site IDs", "key": "siteId", "value": "" }, { "description": "Extension current state", "key": "extensionStatus", "value": "" }, { "description": "Extension types", "key": "extensionType", "value": "Room" } ], "variable": [ { "id": "e65c8b0e-e619-4ac9-816d-f76c8a741914", "key": "accountId", "value": "~", "description": "(Required) Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" } ] }, "description": "Returns contact information on corporate users of federated accounts according to the specified filtering and ordering." }, "response": [ { "id": "a84f5db3-dc1b-4d0e-820b-9613b10f8f7b", "name": "Paged collection of all contacts information for a given account according to filtering and ordering. Records can be empty if no data found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"searchString\": \"\",\n \"searchFields\": [\n \"department\",\n \"firstName\"\n ],\n \"showFederated\": \"\",\n \"showAdminOnlyContacts\": false,\n \"extensionType\": \"Announcement\",\n \"siteId\": \"\",\n \"showExternalContacts\": false,\n \"accountIds\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"siteIds\": [\n \"\",\n \"\"\n ],\n \"extensionStatuses\": [\n \"Enabled\",\n \"NotActivated\"\n ],\n \"extensionTypes\": [\n \"Department\",\n \"Announcement\"\n ],\n \"orderBy\": [\n {\n \"index\": 1,\n \"fieldName\": \"email\",\n \"direction\": \"Asc\"\n },\n {\n \"index\": 1,\n \"fieldName\": \"lastName\",\n \"direction\": \"Asc\"\n }\n ],\n \"page\": \"\",\n \"perPage\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/directory/entries/search?accountId=&department=&siteId=&extensionStatus=&extensionType=Room", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "directory", "entries", "search" ], "query": [ { "description": "A list of Account IDs", "key": "accountId", "value": "" }, { "description": "A list of department names", "key": "department", "value": "" }, { "description": "A list of Site IDs", "key": "siteId", "value": "" }, { "description": "Extension current state", "key": "extensionStatus", "value": "" }, { "description": "Extension types", "key": "extensionType", "value": "Room" } ], "variable": [ { "key": "accountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"records\": [\n {\n \"id\": \"\",\n \"type\": \"PagingOnly\",\n \"status\": \"Unknown\",\n \"account\": {\n \"id\": \"\",\n \"companyName\": \"\",\n \"federatedName\": \"\",\n \"mainNumber\": {\n \"formattedPhoneNumber\": \"\",\n \"phoneNumber\": \"\",\n \"type\": \"\",\n \"label\": \"\",\n \"usageType\": \"MobileNumber\",\n \"hidden\": \"\",\n \"primary\": \"\"\n }\n },\n \"department\": \"\",\n \"email\": \"\",\n \"extensionNumber\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"name\": \"\",\n \"jobTitle\": \"\",\n \"phoneNumbers\": [\n {\n \"formattedPhoneNumber\": \"\",\n \"phoneNumber\": \"\",\n \"type\": \"\",\n \"label\": \"\",\n \"usageType\": \"ContactNumber\",\n \"hidden\": \"\",\n \"primary\": \"\"\n },\n {\n \"formattedPhoneNumber\": \"\",\n \"phoneNumber\": \"\",\n \"type\": \"\",\n \"label\": \"\",\n \"usageType\": \"ForwardedNumber\",\n \"hidden\": \"\",\n \"primary\": \"\"\n }\n ],\n \"profileImage\": {\n \"etag\": \"\",\n \"uri\": \"\"\n },\n \"site\": {\n \"id\": \"\",\n \"name\": \"\",\n \"code\": \"\"\n },\n \"hidden\": \"\",\n \"role\": {\n \"id\": \"\",\n \"name\": \"\",\n \"domain\": \"\",\n \"displayName\": \"\"\n },\n \"callQueues\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"customFields\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"groups\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"costCenter\": {\n \"id\": \"\",\n \"code\": \"\",\n \"name\": \"\"\n },\n \"integration\": {\n \"id\": \"\",\n \"typeId\": \"\",\n \"type\": \"\",\n \"displayName\": \"\",\n \"routingType\": \"\",\n \"outboundEdgeId\": \"\"\n },\n \"subType\": \"DigitalSignage\"\n },\n {\n \"id\": \"\",\n \"type\": \"ProxyAdmin\",\n \"status\": \"Enabled\",\n \"account\": {\n \"id\": \"\",\n \"companyName\": \"\",\n \"federatedName\": \"\",\n \"mainNumber\": {\n \"formattedPhoneNumber\": \"\",\n \"phoneNumber\": \"\",\n \"type\": \"\",\n \"label\": \"\",\n \"usageType\": \"ForwardedNumber\",\n \"hidden\": \"\",\n \"primary\": \"\"\n }\n },\n \"department\": \"\",\n \"email\": \"\",\n \"extensionNumber\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"name\": \"\",\n \"jobTitle\": \"\",\n \"phoneNumbers\": [\n {\n \"formattedPhoneNumber\": \"\",\n \"phoneNumber\": \"\",\n \"type\": \"\",\n \"label\": \"\",\n \"usageType\": \"DirectNumber\",\n \"hidden\": \"\",\n \"primary\": \"\"\n },\n {\n \"formattedPhoneNumber\": \"\",\n \"phoneNumber\": \"\",\n \"type\": \"\",\n \"label\": \"\",\n \"usageType\": \"ContactNumber\",\n \"hidden\": \"\",\n \"primary\": \"\"\n }\n ],\n \"profileImage\": {\n \"etag\": \"\",\n \"uri\": \"\"\n },\n \"site\": {\n \"id\": \"\",\n \"name\": \"\",\n \"code\": \"\"\n },\n \"hidden\": \"\",\n \"role\": {\n \"id\": \"\",\n \"name\": \"\",\n \"domain\": \"\",\n \"displayName\": \"\"\n },\n \"callQueues\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"customFields\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"groups\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"costCenter\": {\n \"id\": \"\",\n \"code\": \"\",\n \"name\": \"\"\n },\n \"integration\": {\n \"id\": \"\",\n \"typeId\": \"\",\n \"type\": \"\",\n \"displayName\": \"\",\n \"routingType\": \"\",\n \"outboundEdgeId\": \"\"\n },\n \"subType\": \"VideoProPlus\"\n }\n ],\n \"paging\": {\n \"perPage\": \"\",\n \"page\": \"\",\n \"pageStart\": \"\",\n \"pageEnd\": \"\",\n \"totalPages\": \"\",\n \"totalElements\": \"\"\n }\n}", "createdAt": "2026-07-28T02:49:42.000Z", "updatedAt": "2026-07-28T02:49:42.000Z", "uid": "35240-a84f5db3-dc1b-4d0e-820b-9613b10f8f7b" }, { "id": "a9ff6245-1921-4867-ac3e-535261a70e34", "name": "Current request cannot be processed due to error in its body and/or url", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"searchString\": \"\",\n \"searchFields\": [\n \"department\",\n \"firstName\"\n ],\n \"showFederated\": \"\",\n \"showAdminOnlyContacts\": false,\n \"extensionType\": \"Announcement\",\n \"siteId\": \"\",\n \"showExternalContacts\": false,\n \"accountIds\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"siteIds\": [\n \"\",\n \"\"\n ],\n \"extensionStatuses\": [\n \"Enabled\",\n \"NotActivated\"\n ],\n \"extensionTypes\": [\n \"Department\",\n \"Announcement\"\n ],\n \"orderBy\": [\n {\n \"index\": 1,\n \"fieldName\": \"email\",\n \"direction\": \"Asc\"\n },\n {\n \"index\": 1,\n \"fieldName\": \"lastName\",\n \"direction\": \"Asc\"\n }\n ],\n \"page\": \"\",\n \"perPage\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/directory/entries/search?accountId=&department=&siteId=&extensionStatus=&extensionType=Room", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "directory", "entries", "search" ], "query": [ { "description": "A list of Account IDs", "key": "accountId", "value": "" }, { "description": "A list of department names", "key": "department", "value": "" }, { "description": "A list of Site IDs", "key": "siteId", "value": "" }, { "description": "Extension current state", "key": "extensionStatus", "value": "" }, { "description": "Extension types", "key": "extensionType", "value": "Room" } ], "variable": [ { "key": "accountId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"ErrorCode{code='ADG-121', httpStatus=400, description='Parameter [${paramName}] is invalid. ${additionalInfo:-}'}\",\n \"message\": \"\"\n },\n {\n \"errorCode\": \"ErrorCode{code='ADG-102', httpStatus=405, description='Method not allowed.'}\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:49:42.000Z", "updatedAt": "2026-07-28T02:49:42.000Z", "uid": "35240-a9ff6245-1921-4867-ac3e-535261a70e34" }, { "id": "ee4f34b8-679c-453a-8a54-3cba744e940a", "name": "Some unexpected error during current request processing.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"searchString\": \"\",\n \"searchFields\": [\n \"department\",\n \"firstName\"\n ],\n \"showFederated\": \"\",\n \"showAdminOnlyContacts\": false,\n \"extensionType\": \"Announcement\",\n \"siteId\": \"\",\n \"showExternalContacts\": false,\n \"accountIds\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"siteIds\": [\n \"\",\n \"\"\n ],\n \"extensionStatuses\": [\n \"Enabled\",\n \"NotActivated\"\n ],\n \"extensionTypes\": [\n \"Department\",\n \"Announcement\"\n ],\n \"orderBy\": [\n {\n \"index\": 1,\n \"fieldName\": \"email\",\n \"direction\": \"Asc\"\n },\n {\n \"index\": 1,\n \"fieldName\": \"lastName\",\n \"direction\": \"Asc\"\n }\n ],\n \"page\": \"\",\n \"perPage\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/directory/entries/search?accountId=&department=&siteId=&extensionStatus=&extensionType=Room", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "directory", "entries", "search" ], "query": [ { "description": "A list of Account IDs", "key": "accountId", "value": "" }, { "description": "A list of department names", "key": "department", "value": "" }, { "description": "A list of Site IDs", "key": "siteId", "value": "" }, { "description": "Extension current state", "key": "extensionStatus", "value": "" }, { "description": "Extension types", "key": "extensionType", "value": "Room" } ], "variable": [ { "key": "accountId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"ErrorCode{code='ADG-121', httpStatus=400, description='Parameter [${paramName}] is invalid. ${additionalInfo:-}'}\",\n \"message\": \"\"\n },\n {\n \"errorCode\": \"ErrorCode{code='ADG-102', httpStatus=405, description='Method not allowed.'}\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:49:42.000Z", "updatedAt": "2026-07-28T02:49:42.000Z", "uid": "35240-ee4f34b8-679c-453a-8a54-3cba744e940a" }, { "id": "43d1bc92-7508-4692-ab97-08792fa4f004", "name": "Network error during request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"searchString\": \"\",\n \"searchFields\": [\n \"department\",\n \"firstName\"\n ],\n \"showFederated\": \"\",\n \"showAdminOnlyContacts\": false,\n \"extensionType\": \"Announcement\",\n \"siteId\": \"\",\n \"showExternalContacts\": false,\n \"accountIds\": [\n \"\",\n \"\"\n ],\n \"department\": \"\",\n \"siteIds\": [\n \"\",\n \"\"\n ],\n \"extensionStatuses\": [\n \"Enabled\",\n \"NotActivated\"\n ],\n \"extensionTypes\": [\n \"Department\",\n \"Announcement\"\n ],\n \"orderBy\": [\n {\n \"index\": 1,\n \"fieldName\": \"email\",\n \"direction\": \"Asc\"\n },\n {\n \"index\": 1,\n \"fieldName\": \"lastName\",\n \"direction\": \"Asc\"\n }\n ],\n \"page\": \"\",\n \"perPage\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/directory/entries/search?accountId=&department=&siteId=&extensionStatus=&extensionType=Room", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "directory", "entries", "search" ], "query": [ { "description": "A list of Account IDs", "key": "accountId", "value": "" }, { "description": "A list of department names", "key": "department", "value": "" }, { "description": "A list of Site IDs", "key": "siteId", "value": "" }, { "description": "Extension current state", "key": "extensionStatus", "value": "" }, { "description": "Extension types", "key": "extensionType", "value": "Room" } ], "variable": [ { "key": "accountId" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"ErrorCode{code='ADG-121', httpStatus=400, description='Parameter [${paramName}] is invalid. ${additionalInfo:-}'}\",\n \"message\": \"\"\n },\n {\n \"errorCode\": \"ErrorCode{code='ADG-102', httpStatus=405, description='Method not allowed.'}\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:49:42.000Z", "updatedAt": "2026-07-28T02:49:42.000Z", "uid": "35240-43d1bc92-7508-4692-ab97-08792fa4f004" } ], "createdAt": "2026-07-28T02:49:42.000Z", "updatedAt": "2026-07-28T02:49:42.000Z", "uid": "35240-6c1b3ade-76fb-43cf-996c-7f31f7e4a86b" } ], "id": "7aadc98c-ff06-4f7e-ac63-c3ae4effb9f1", "createdAt": "2026-07-28T02:49:42.000Z", "updatedAt": "2026-07-28T02:49:42.000Z", "uid": "35240-7aadc98c-ff06-4f7e-ac63-c3ae4effb9f1" }, { "name": "Get Company Directory Entries", "id": "68fcd548-0f83-4646-b9b6-24fdf75805b5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "User in GET requests to skip retrieving the data if the provided value matches current `ETag` associated with this resource.\nThe server checks the current resource ETag and returns the data only if mismatches the `If-None-Match` value,\notherwise `HTTP 304 Not Modified` status is returned.\n", "key": "If-None-Match", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/directory/entries?showFederated=true&type=Voicemail&typeGroup=User&page=1&perPage=1000&siteId=", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "directory", "entries" ], "query": [ { "description": "If `true` then contacts of all accounts in federation are returned. If `false` then only contacts of the current account are returned, and account section is eliminated in this case", "key": "showFederated", "value": "true" }, { "description": "Type of an extension. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology", "key": "type", "value": "Voicemail" }, { "description": "Type of extension group", "key": "typeGroup", "value": "User" }, { "description": "Page number", "key": "page", "value": "1" }, { "description": "Records count to be returned per one page. It can be either integer or string with the specific keyword values:\n- `all` - all records are returned in one page\n- `max` - maximum count of records that can be returned in one page\n", "key": "perPage", "value": "1000" }, { "description": "Internal identifier of the business site to which extensions belong", "key": "siteId", "value": "" } ], "variable": [ { "id": "148b296b-c4ed-4c32-b3d9-adb7e2be9b75", "key": "accountId", "value": "~", "description": "(Required) Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" } ] }, "description": "Returns contact information on corporate users of federated accounts. Please note: 1. `User`, `DigitalUser`, `VirtualUser` and `FaxUser` types are returned as `User` type. 2. `ApplicationExtension` type is not returned. 3. Only extensions in `Enabled`, `Disabled` and `NotActivated` state are returned." }, "response": [ { "id": "eb7d424c-76bd-488b-ac96-503940b43353", "name": "Paged collection of all contacts information for a given account. Records can be empty if no data found.", "originalRequest": { "method": "GET", "header": [ { "description": "User in GET requests to skip retrieving the data if the provided value matches current `ETag` associated with this resource.\nThe server checks the current resource ETag and returns the data only if mismatches the `If-None-Match` value,\notherwise `HTTP 304 Not Modified` status is returned.\n", "key": "If-None-Match", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/directory/entries?showFederated=true&type=Voicemail&typeGroup=User&page=1&perPage=1000&siteId=", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "directory", "entries" ], "query": [ { "description": "If `true` then contacts of all accounts in federation are returned. If `false` then only contacts of the current account are returned, and account section is eliminated in this case", "key": "showFederated", "value": "true" }, { "description": "Type of an extension. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology", "key": "type", "value": "Voicemail" }, { "description": "Type of extension group", "key": "typeGroup", "value": "User" }, { "description": "Page number", "key": "page", "value": "1" }, { "description": "Records count to be returned per one page. It can be either integer or string with the specific keyword values:\n- `all` - all records are returned in one page\n- `max` - maximum count of records that can be returned in one page\n", "key": "perPage", "value": "1000" }, { "description": "Internal identifier of the business site to which extensions belong", "key": "siteId", "value": "" } ], "variable": [ { "key": "accountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"records\": [\n {\n \"id\": \"\",\n \"type\": \"PagingOnly\",\n \"status\": \"Unknown\",\n \"account\": {\n \"id\": \"\",\n \"companyName\": \"\",\n \"federatedName\": \"\",\n \"mainNumber\": {\n \"formattedPhoneNumber\": \"\",\n \"phoneNumber\": \"\",\n \"type\": \"\",\n \"label\": \"\",\n \"usageType\": \"MobileNumber\",\n \"hidden\": \"\",\n \"primary\": \"\"\n }\n },\n \"department\": \"\",\n \"email\": \"\",\n \"extensionNumber\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"name\": \"\",\n \"jobTitle\": \"\",\n \"phoneNumbers\": [\n {\n \"formattedPhoneNumber\": \"\",\n \"phoneNumber\": \"\",\n \"type\": \"\",\n \"label\": \"\",\n \"usageType\": \"ContactNumber\",\n \"hidden\": \"\",\n \"primary\": \"\"\n },\n {\n \"formattedPhoneNumber\": \"\",\n \"phoneNumber\": \"\",\n \"type\": \"\",\n \"label\": \"\",\n \"usageType\": \"ForwardedNumber\",\n \"hidden\": \"\",\n \"primary\": \"\"\n }\n ],\n \"profileImage\": {\n \"etag\": \"\",\n \"uri\": \"\"\n },\n \"site\": {\n \"id\": \"\",\n \"name\": \"\",\n \"code\": \"\"\n },\n \"hidden\": \"\",\n \"role\": {\n \"id\": \"\",\n \"name\": \"\",\n \"domain\": \"\",\n \"displayName\": \"\"\n },\n \"callQueues\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"customFields\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"groups\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"costCenter\": {\n \"id\": \"\",\n \"code\": \"\",\n \"name\": \"\"\n },\n \"integration\": {\n \"id\": \"\",\n \"typeId\": \"\",\n \"type\": \"\",\n \"displayName\": \"\",\n \"routingType\": \"\",\n \"outboundEdgeId\": \"\"\n },\n \"subType\": \"DigitalSignage\"\n },\n {\n \"id\": \"\",\n \"type\": \"ProxyAdmin\",\n \"status\": \"Enabled\",\n \"account\": {\n \"id\": \"\",\n \"companyName\": \"\",\n \"federatedName\": \"\",\n \"mainNumber\": {\n \"formattedPhoneNumber\": \"\",\n \"phoneNumber\": \"\",\n \"type\": \"\",\n \"label\": \"\",\n \"usageType\": \"ForwardedNumber\",\n \"hidden\": \"\",\n \"primary\": \"\"\n }\n },\n \"department\": \"\",\n \"email\": \"\",\n \"extensionNumber\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"name\": \"\",\n \"jobTitle\": \"\",\n \"phoneNumbers\": [\n {\n \"formattedPhoneNumber\": \"\",\n \"phoneNumber\": \"\",\n \"type\": \"\",\n \"label\": \"\",\n \"usageType\": \"DirectNumber\",\n \"hidden\": \"\",\n \"primary\": \"\"\n },\n {\n \"formattedPhoneNumber\": \"\",\n \"phoneNumber\": \"\",\n \"type\": \"\",\n \"label\": \"\",\n \"usageType\": \"ContactNumber\",\n \"hidden\": \"\",\n \"primary\": \"\"\n }\n ],\n \"profileImage\": {\n \"etag\": \"\",\n \"uri\": \"\"\n },\n \"site\": {\n \"id\": \"\",\n \"name\": \"\",\n \"code\": \"\"\n },\n \"hidden\": \"\",\n \"role\": {\n \"id\": \"\",\n \"name\": \"\",\n \"domain\": \"\",\n \"displayName\": \"\"\n },\n \"callQueues\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"customFields\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"groups\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"costCenter\": {\n \"id\": \"\",\n \"code\": \"\",\n \"name\": \"\"\n },\n \"integration\": {\n \"id\": \"\",\n \"typeId\": \"\",\n \"type\": \"\",\n \"displayName\": \"\",\n \"routingType\": \"\",\n \"outboundEdgeId\": \"\"\n },\n \"subType\": \"VideoProPlus\"\n }\n ],\n \"paging\": {\n \"perPage\": \"\",\n \"page\": \"\",\n \"pageStart\": \"\",\n \"pageEnd\": \"\",\n \"totalPages\": \"\",\n \"totalElements\": \"\"\n }\n}", "createdAt": "2026-07-28T02:49:42.000Z", "updatedAt": "2026-07-28T02:49:42.000Z", "uid": "35240-eb7d424c-76bd-488b-ac96-503940b43353" }, { "id": "ec914033-54c1-4bc2-95a1-b9f3bed67394", "name": "Current request cannot be processed due to error in its body and/or url.", "originalRequest": { "method": "GET", "header": [ { "description": "User in GET requests to skip retrieving the data if the provided value matches current `ETag` associated with this resource.\nThe server checks the current resource ETag and returns the data only if mismatches the `If-None-Match` value,\notherwise `HTTP 304 Not Modified` status is returned.\n", "key": "If-None-Match", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/directory/entries?showFederated=true&type=Voicemail&typeGroup=User&page=1&perPage=1000&siteId=", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "directory", "entries" ], "query": [ { "description": "If `true` then contacts of all accounts in federation are returned. If `false` then only contacts of the current account are returned, and account section is eliminated in this case", "key": "showFederated", "value": "true" }, { "description": "Type of an extension. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology", "key": "type", "value": "Voicemail" }, { "description": "Type of extension group", "key": "typeGroup", "value": "User" }, { "description": "Page number", "key": "page", "value": "1" }, { "description": "Records count to be returned per one page. It can be either integer or string with the specific keyword values:\n- `all` - all records are returned in one page\n- `max` - maximum count of records that can be returned in one page\n", "key": "perPage", "value": "1000" }, { "description": "Internal identifier of the business site to which extensions belong", "key": "siteId", "value": "" } ], "variable": [ { "key": "accountId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"ErrorCode{code='ADG-121', httpStatus=400, description='Parameter [${paramName}] is invalid. ${additionalInfo:-}'}\",\n \"message\": \"\"\n },\n {\n \"errorCode\": \"ErrorCode{code='ADG-102', httpStatus=405, description='Method not allowed.'}\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:49:42.000Z", "updatedAt": "2026-07-28T02:49:42.000Z", "uid": "35240-ec914033-54c1-4bc2-95a1-b9f3bed67394" }, { "id": "c004ed40-5f13-428a-92fa-07dd5779b7b8", "name": "Some unexpected error during current request processing.", "originalRequest": { "method": "GET", "header": [ { "description": "User in GET requests to skip retrieving the data if the provided value matches current `ETag` associated with this resource.\nThe server checks the current resource ETag and returns the data only if mismatches the `If-None-Match` value,\notherwise `HTTP 304 Not Modified` status is returned.\n", "key": "If-None-Match", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/directory/entries?showFederated=true&type=Voicemail&typeGroup=User&page=1&perPage=1000&siteId=", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "directory", "entries" ], "query": [ { "description": "If `true` then contacts of all accounts in federation are returned. If `false` then only contacts of the current account are returned, and account section is eliminated in this case", "key": "showFederated", "value": "true" }, { "description": "Type of an extension. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology", "key": "type", "value": "Voicemail" }, { "description": "Type of extension group", "key": "typeGroup", "value": "User" }, { "description": "Page number", "key": "page", "value": "1" }, { "description": "Records count to be returned per one page. It can be either integer or string with the specific keyword values:\n- `all` - all records are returned in one page\n- `max` - maximum count of records that can be returned in one page\n", "key": "perPage", "value": "1000" }, { "description": "Internal identifier of the business site to which extensions belong", "key": "siteId", "value": "" } ], "variable": [ { "key": "accountId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"ErrorCode{code='ADG-121', httpStatus=400, description='Parameter [${paramName}] is invalid. ${additionalInfo:-}'}\",\n \"message\": \"\"\n },\n {\n \"errorCode\": \"ErrorCode{code='ADG-102', httpStatus=405, description='Method not allowed.'}\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:49:42.000Z", "updatedAt": "2026-07-28T02:49:42.000Z", "uid": "35240-c004ed40-5f13-428a-92fa-07dd5779b7b8" }, { "id": "2aced98e-2580-4455-8f89-1bfd7058d010", "name": "Network error during request", "originalRequest": { "method": "GET", "header": [ { "description": "User in GET requests to skip retrieving the data if the provided value matches current `ETag` associated with this resource.\nThe server checks the current resource ETag and returns the data only if mismatches the `If-None-Match` value,\notherwise `HTTP 304 Not Modified` status is returned.\n", "key": "If-None-Match", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/directory/entries?showFederated=true&type=Voicemail&typeGroup=User&page=1&perPage=1000&siteId=", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "directory", "entries" ], "query": [ { "description": "If `true` then contacts of all accounts in federation are returned. If `false` then only contacts of the current account are returned, and account section is eliminated in this case", "key": "showFederated", "value": "true" }, { "description": "Type of an extension. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology", "key": "type", "value": "Voicemail" }, { "description": "Type of extension group", "key": "typeGroup", "value": "User" }, { "description": "Page number", "key": "page", "value": "1" }, { "description": "Records count to be returned per one page. It can be either integer or string with the specific keyword values:\n- `all` - all records are returned in one page\n- `max` - maximum count of records that can be returned in one page\n", "key": "perPage", "value": "1000" }, { "description": "Internal identifier of the business site to which extensions belong", "key": "siteId", "value": "" } ], "variable": [ { "key": "accountId" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"ErrorCode{code='ADG-121', httpStatus=400, description='Parameter [${paramName}] is invalid. ${additionalInfo:-}'}\",\n \"message\": \"\"\n },\n {\n \"errorCode\": \"ErrorCode{code='ADG-102', httpStatus=405, description='Method not allowed.'}\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:49:42.000Z", "updatedAt": "2026-07-28T02:49:42.000Z", "uid": "35240-2aced98e-2580-4455-8f89-1bfd7058d010" } ], "createdAt": "2026-07-28T02:49:42.000Z", "updatedAt": "2026-07-28T02:49:42.000Z", "uid": "35240-68fcd548-0f83-4646-b9b6-24fdf75805b5" } ], "id": "9498518d-505f-472d-952c-8d9522eeec0a", "createdAt": "2026-07-28T02:49:42.000Z", "updatedAt": "2026-07-28T02:49:42.000Z", "uid": "35240-9498518d-505f-472d-952c-8d9522eeec0a" }, { "name": "federation", "item": [ { "name": "Get Account Federation", "id": "c68a32b8-eff9-4b8f-b0dd-e6412e131eef", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "RingCentral extension id", "key": "RCExtensionId", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/directory/federation?types=Regular", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "directory", "federation" ], "query": [ { "description": "Filter by federation types. Default is Regular", "key": "types", "value": "Regular" } ], "variable": [ { "id": "a9abf761-eda2-4bae-b4f0-b3f941896bdd", "key": "accountId", "value": "~", "description": "(Required) Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" } ] }, "description": "Returns information on a federation and associated accounts." }, "response": [ { "id": "f79b800a-b4b7-4963-9ca3-cf40461f8a8e", "name": "List of found federations. Records array can be empty if no data found", "originalRequest": { "method": "GET", "header": [ { "description": "RingCentral extension id", "key": "RCExtensionId", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/directory/federation?types=Regular", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "directory", "federation" ], "query": [ { "description": "Filter by federation types. Default is Regular", "key": "types", "value": "Regular" } ], "variable": [ { "key": "accountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"accounts\": [\n {\n \"id\": \"\",\n \"companyName\": \"\",\n \"conflictCount\": \"\",\n \"federatedName\": \"\",\n \"linkCreationTime\": \"\",\n \"mainNumber\": {\n \"formattedPhoneNumber\": \"\",\n \"phoneNumber\": \"\",\n \"type\": \"\",\n \"label\": \"\",\n \"usageType\": \"ForwardedNumber\",\n \"hidden\": \"\",\n \"primary\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"companyName\": \"\",\n \"conflictCount\": \"\",\n \"federatedName\": \"\",\n \"linkCreationTime\": \"\",\n \"mainNumber\": {\n \"formattedPhoneNumber\": \"\",\n \"phoneNumber\": \"\",\n \"type\": \"\",\n \"label\": \"\",\n \"usageType\": \"MobileNumber\",\n \"hidden\": \"\",\n \"primary\": \"\"\n }\n }\n ],\n \"creationTime\": \"\",\n \"displayName\": \"\",\n \"id\": \"\",\n \"lastModifiedTime\": \"\",\n \"type\": \"Regular\"\n}", "createdAt": "2026-07-28T02:49:42.000Z", "updatedAt": "2026-07-28T02:49:42.000Z", "uid": "35240-f79b800a-b4b7-4963-9ca3-cf40461f8a8e" }, { "id": "6f6cb828-e816-483f-b6e1-b3b82ae5c65e", "name": "Current request cannot be processed due to error in its body and/or url", "originalRequest": { "method": "GET", "header": [ { "description": "RingCentral extension id", "key": "RCExtensionId", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/directory/federation?types=Regular", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "directory", "federation" ], "query": [ { "description": "Filter by federation types. Default is Regular", "key": "types", "value": "Regular" } ], "variable": [ { "key": "accountId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"ErrorCode{code='ADG-121', httpStatus=400, description='Parameter [${paramName}] is invalid. ${additionalInfo:-}'}\",\n \"message\": \"\"\n },\n {\n \"errorCode\": \"ErrorCode{code='ADG-102', httpStatus=405, description='Method not allowed.'}\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:49:42.000Z", "updatedAt": "2026-07-28T02:49:42.000Z", "uid": "35240-6f6cb828-e816-483f-b6e1-b3b82ae5c65e" }, { "id": "6c436cbe-f236-4ba8-ab3e-420f8687f101", "name": "Some unexpected error during current request processing.", "originalRequest": { "method": "GET", "header": [ { "description": "RingCentral extension id", "key": "RCExtensionId", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/directory/federation?types=Regular", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "directory", "federation" ], "query": [ { "description": "Filter by federation types. Default is Regular", "key": "types", "value": "Regular" } ], "variable": [ { "key": "accountId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"ErrorCode{code='ADG-121', httpStatus=400, description='Parameter [${paramName}] is invalid. ${additionalInfo:-}'}\",\n \"message\": \"\"\n },\n {\n \"errorCode\": \"ErrorCode{code='ADG-102', httpStatus=405, description='Method not allowed.'}\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:49:42.000Z", "updatedAt": "2026-07-28T02:49:42.000Z", "uid": "35240-6c436cbe-f236-4ba8-ab3e-420f8687f101" }, { "id": "b3b6da8c-eb01-4e08-bc05-5cefb7732bcd", "name": "Network error during request", "originalRequest": { "method": "GET", "header": [ { "description": "RingCentral extension id", "key": "RCExtensionId", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/directory/federation?types=Regular", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "directory", "federation" ], "query": [ { "description": "Filter by federation types. Default is Regular", "key": "types", "value": "Regular" } ], "variable": [ { "key": "accountId" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"ErrorCode{code='ADG-121', httpStatus=400, description='Parameter [${paramName}] is invalid. ${additionalInfo:-}'}\",\n \"message\": \"\"\n },\n {\n \"errorCode\": \"ErrorCode{code='ADG-102', httpStatus=405, description='Method not allowed.'}\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:49:42.000Z", "updatedAt": "2026-07-28T02:49:42.000Z", "uid": "35240-b3b6da8c-eb01-4e08-bc05-5cefb7732bcd" } ], "createdAt": "2026-07-28T02:49:42.000Z", "updatedAt": "2026-07-28T02:49:42.000Z", "uid": "35240-c68a32b8-eff9-4b8f-b0dd-e6412e131eef" } ], "id": "94398b17-5ecb-452b-b1e0-a7c8b6b9deb9", "createdAt": "2026-07-28T02:49:42.000Z", "updatedAt": "2026-07-28T02:49:42.000Z", "uid": "35240-94398b17-5ecb-452b-b1e0-a7c8b6b9deb9" } ], "id": "faae444f-0da3-48de-91bf-c910f0b481e9", "createdAt": "2026-07-28T02:49:42.000Z", "updatedAt": "2026-07-28T02:49:42.000Z", "uid": "35240-faae444f-0da3-48de-91bf-c910f0b481e9" } ], "id": "534c8e0b-dc5f-4db0-98e6-5504bcb3d5c6", "createdAt": "2026-07-28T02:49:42.000Z", "updatedAt": "2026-07-28T02:49:42.000Z", "uid": "35240-534c8e0b-dc5f-4db0-98e6-5504bcb3d5c6" } ], "id": "faf3e3d6-ddd6-4c35-8967-dc4cddf65621", "createdAt": "2026-07-28T02:49:42.000Z", "updatedAt": "2026-07-28T02:49:42.000Z", "uid": "35240-faf3e3d6-ddd6-4c35-8967-dc4cddf65621" } ], "id": "5b87728e-e894-4462-9eca-5b46389d16fc", "createdAt": "2026-07-28T02:49:42.000Z", "updatedAt": "2026-07-28T02:49:42.000Z", "uid": "35240-5b87728e-e894-4462-9eca-5b46389d16fc" } ], "id": "b3fb6ee5-3ae5-4fcc-9759-1a12785ac114", "createdAt": "2026-07-28T02:49:42.000Z", "updatedAt": "2026-07-28T02:49:42.000Z", "uid": "35240-b3fb6ee5-3ae5-4fcc-9759-1a12785ac114" } ], "auth": { "type": "oauth2", "oauth2": [ { "key": "redirect_uri", "value": "https://platform.ringcentral.com/restapi/oauth/token", "type": "string" }, { "key": "accessTokenUrl", "value": "https://platform.ringcentral.com/restapi/oauth/token", "type": "string" }, { "key": "authUrl", "value": "https://platform.ringcentral.com/restapi/oauth/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://platform.ringcentral.com" } ] }