Get Directory

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 #

Authorization: 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"]
	"status": "success",
	"timestamp": "2019-01-01T10:00:00.2890319Z"

Errors #

Unauthorized #

When the token is not provided, invalid or expired

HTTP/1.1 401 Unauthorized

Not Found #

When there are no directories that have a matching directory id

HTTP/1.1 404 Not Found
Date: Thu, 06 Feb 2020 12:46:58 GMT
Content-Type: application/json; charset=utf-8
Content-Length: 95
	"error": 404,
	"message": "Not Found",
	"status": "error",
	"timestamp": "2020-02-06T12:46:58.7669535Z"