GET
/
v1
/
Inbound
curl --request GET \
  --url https://api.nlpearl.ai/v1/Inbound \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "<string>",
    "name": "<string>",
    "totalAgents": 123,
    "status": 123,
    "created": "2023-11-07T05:31:56Z"
  }
]

Authorizations

​
Authorization
string
header
required

Specify the authorization token.

For more information, check out the Authorization Guide.

Response

200
text/plain
List of all inbound for the client.
​
id
string | null

The unique identifier of the inboundy.

​
name
string | null

The name of the inbound.

​
totalAgents
integer

The total number of agents allocated to this inbound.

​
status
integer

Here is the activity status

1 - Running

2 - Paused

3 - Suspended

10 - TemporaryMaintenance

​
created
string

The date and time when the inbound was created.

Reset Customer MemoryGet Inbound