Skip to main content
GET
Get Pearl

Authorizations

Authorization
string
header
required

Specify the authorization token in the form AccountId:SecretKey, or an OAuth 2.0 access token.

For more information, check out the Authorization Guide and the OAuth 2.0 Guide.

Path Parameters

pearlId
string
required

Response

Details of the specific Pearl.

id
string | null

The unique identifier of the pearl.

name
string | null

The name of the pearl.

type
integer<int32> | null

Defines the type of activity of the pearl.

1 - Inbound

2 - Outbound

status
integer<int32>

Here is the activity status

1 - Running

2 - Paused

3 - Suspended

10 - TemporaryMaintenance

phoneNumber
string | null

The phone number assigned to the pearl.

totalAgents
integer<int32>

The total number of agents allocated to the pearl.

created
string<date-time>

The date and time when the pearl was created.

budgetConsumed
integer<int32>

The amount of budget consumed so far for the pearl.

totalTodayCalls
integer<int32>

The total number of calls made today for the pearl.

totalOngoingCalls
integer<int32>

The total number of ongoing calls for the pearl.

totalOnQueue
integer<int32> | null

The number of calls currently waiting in the queue (inbound only).

totalLeads
integer<int32> | null

The total number of leads associated with the pearl (outbound only).

totalLeadsCompleted
integer<int32> | null

The total number of leads that have been completed (outbound only).

totalLeadsSuccess
integer<int32> | null

The total number of leads successfully converted (outbound only).

budgetTotal
integer<int32> | null

The total budget allocated for the pearl (outbound only).