Sign in

v1

latestSwagger 2.0Apache 2.02026-07-13123128517.6 KB
contacts

Find a specific contact list

Returns a single ContactList instance for a given contact list id

get/contacts/lists/{id}

Path parameters

idinteger required

An id of a contact list to return

Query parameters

fieldsstring

Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at partial response page.

Response

successful operation

idinteger

An Id of a contact list

namestring

A name of a contact list

sizeinteger

A number of contacts in a contact list

createdinteger

A time when a given resource was created, formatted in unix time milliseconds (read only). Example: 1473781817000 for Sat, 05 Jan 1985 14:03:37 GMT

status'ACTIVE' | 'VALIDATING' | 'IMPORTING' | 'IMPORT_FAILED' | 'ERRORS' | 'DELETED' | 'PARSE_FAILED' | 'COLUMN_TOO_LARGE'

A current status of a contact list, available values: ACTIVE - contact list is ready, VALIDATING - contact list validation is in progress, IMPORTING - importing is in progress, IMPORT_FAILED - in case of errors occurred during the importing, ERRORS - contact list has validation errors, DELETED - contact list was deleted, PARSE_FAILED - contacts cannot be parsed, COLUMN_TOO_LARGE - if size of phone number or any other column exceeds 255 characters