Skip to main content
GET
/
v2
/
Pearl
/
{pearlId}
Get Pearl
curl --request GET \
  --url https://api.nlpearl.ai/v2/Pearl/{pearlId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "name": "<string>",
  "status": 123,
  "phoneNumber": "<string>",
  "totalAgents": 123,
  "created": "2023-11-07T05:31:56Z",
  "budgetConsumed": 123,
  "totalTodayCalls": 123,
  "totalOngoingCalls": 123,
  "totalOnQueue": 123,
  "totalLeads": 123,
  "totalLeadsCompleted": 123,
  "totalLeadsSuccess": 123,
  "budgetTotal": 123
}

Authorizations

Authorization
string
header
required

Specify the authorization token.

For more information, check out the Authorization Guide.

Path Parameters

pearlId
string
required

Response

Details of the specific Pearl.

id
string | null
name
string | null
status
integer

Here is the activity status

1 - Running

2 - Paused

3 - Suspended

10 - TemporaryMaintenance

phoneNumber
string | null
totalAgents
integer
created
string<date-time>
budgetConsumed
integer
totalTodayCalls
integer
totalOngoingCalls
integer
totalOnQueue
integer | null
totalLeads
integer | null
totalLeadsCompleted
integer | null
totalLeadsSuccess
integer | null
budgetTotal
integer | null