Skip to main content
GET
/
v1
/
Inbound
/
{inboundId}
Get Inbound
curl --request GET \
  --url https://api.nlpearl.ai/v1/Inbound/{inboundId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "name": "<string>",
  "status": 123,
  "pearlName": "<string>",
  "totalAgents": 123,
  "phoneNumber": "<string>",
  "totalTodayCalls": 123,
  "totalOngoingCalls": 123,
  "totalOnQueue": 123,
  "created": "2023-11-07T05:31:56Z",
  "creditUsed": 123
}

Documentation Index

Fetch the complete documentation index at: https://developers.nlpearl.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Specify the authorization token.

For more information, check out the Authorization Guide.

Path Parameters

​
inboundId
string
required

The unique identifier of the inbound.

Response

Details of the specific inbound.

​
id
string | null

The unique identifier of the inbound activity.

​
name
string | null

The name of the inbound activity.

​
status
integer<int32>

Here is the activity status

1 - Running

2 - Paused

3 - Suspended

10 - TemporaryMaintenance

​
pearlName
string | null

The name of the Pearl associated with this inbound activity.

​
totalAgents
integer<int32>

The total number of agents allocated to this inbound activity.

​
phoneNumber
string | null

The phone number associated with this inbound activity.

​
totalTodayCalls
integer<int32>

The total number of calls received today.

​
totalOngoingCalls
integer<int32>

The total number of ongoing calls.

​
totalOnQueue
integer<int32>

The total number of calls currently in the queue.

​
created
string<date-time>

The date and time when the inbound activity was created.

​
creditUsed
integer<int32>