Get All Directories

Mon, 01 Jan 0001 00:00:00 +0000

Get All Directories #

Gets a list of all directories configured on your account. Once a list of all directories has been retrieved, specific details about directory items can be retrieved using the other available interfaces.

GET /v1.0/contactdirectories

Example #

This request will get a list of all directories configured on your ~.Dimensions.~ account.

Request #

GET <https://api.na.myreports.cloud/api/v1.0/contactdirectories> HTTP/1.1
Authorisation: Bearer {TOKEN}

Response #

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: xx
{
	"page_size": 1,
    "data": \[{
            "id": "00000000-0000-0000-0000-000000000000",
            "name": "My Global",
            "description": "This is my global directory",
            "fields": ["title", "fullName", "companyName", "jobTitle", "phone1", "phone2", "phone3", "phone4", "email", "crmId", "field1", "field2", "field3", "field4", "field5", "field6", "field7", "field8", "field9", "field10", "avatar"]["title", "fullName", "companyName", "jobTitle", "phone1", "phone2", "phone3", "phone4", "email", "crmId", "field1", "field2", "field3", "field4", "field5", "field6", "field7", "field8", "field9", "field10", "avatar"]
        }
    ],
	"status": "success",
	"timestamp": "2019-05-01T10:00:00.2890319Z"
}

Errors #

Unauthorised #

When the token is not provided, invalid or expired

HTTP/1.1 401 Unauthorised

Get Directory

Mon, 01 Jan 0001 00:00:00 +0000

Get Directory #

Get details of a specific directory.

GET /v1.0/contactdirectories/{DIRECTORY_ID}

Example #

This request will retrieve the directory details for a specific directory id.

Request #

GET <https://api.na.myreports.cloud/api/v1.0/contactdirectories/00000000-0000-0000-0000-000000000000> HTTP/1.1
Authorisation: Bearer {TOKEN}

Response #

HTTP/1.1 200 OK
Content-Type: application/octet-stream; charset=utf-8
Content-Length: xx
{
    "page_size": 1,
    "data": \[{
            "id": "00000000-0000-0000-0000-000000000000",
            "name": "My Global",
            "description": "This is my global directory",
            "fields": ["title", "fullName", "companyName", "jobTitle", "phone1", "phone2", "phone3", "phone4", "email", "crmId", "field1", "field2", "field3", "field4", "field5", "field6", "field7", "field8", "field9", "field10", "avatar"]["title", "fullName", "companyName", "jobTitle", "phone1", "phone2", "phone3", "phone4", "email", "crmId", "field1", "field2", "field3", "field4", "field5", "field6", "field7", "field8", "field9", "field10", "avatar"]
        }
    ],
	"status": "success",
	"timestamp": "2019-01-01T10:00:00.2890319Z"
}

Errors #

Unauthorised #

When the token is not provided, invalid or expired

HTTP/1.1 401 Unauthorised

Contact Directories Overview on ~.UcClient.~ Unified Communications

Get All Directories

Get All Directories #

Example #

Request #

Response #

Errors #

Unauthorised #

Get Directory

Get Directory #

Example #

Request #

Response #

Errors #

Unauthorised #