Get contacts

get

https://api.indigitall.com/v2/chat/{applicationId}/contact

Retrieve a list of contacts for a given application.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

applicationId

integer

required

Application's ID

Query Params

limit

integer

1 to 100

Defaults to 25

Limit the number of contacts returned.

page

integer

≥ 0

Defaults to 0

Page number

contactCode

string

Filters contacts by their code:

Up to 5 characters: Performs a prefix search (starts with).
More than 5 characters: Performs an exact match on the full code.

externalCode

string

Filter contacts by externalCode.

count

boolean

Defaults to false

If true, returns the total count of contacts matching the filter along with the data.

orderBy

string

enum

Optional field to order the contacts list by.

lastMessageId: Order contacts by their last message ID descending (most recent activity first). Contacts without messages appear last.

Allowed:

conversationStatus

string

enum

Filter contacts by their latest contact center conversation:

active: latest conversation is assigned to an agent and not closed.
pending: latest conversation is not assigned to an agent and not closed.
closed: latest conversation is closed.
none: contact has no conversations.
omitted: all contacts.

Allowed:

reactiveEnabled

boolean

Filter contacts by reactive messaging availability:

true: contacts that are not reactively blocked.
false: contacts that are reactively blocked.
omitted: all contacts.

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200A list of contact objects.

403Forbidden

500Internal server error