NLnlpearl
Pearl

Get Pearl

Retrieves a specific Pearl by its ID

get/v2/Pearl/{pearlId}

Request

  • Base URL
    https://api.nlpearl.ai
  • Auth
    HTTP bearer

Path parameters

pearlIdstring required

Response

Details of the specific Pearl.

idstring nullable

The unique identifier of the pearl.

namestring nullable

The name of the pearl.

typeinteger

Defines the type of activity of the pearl.

1 - Inbound

2 - Outbound

statusinteger

Here is the activity status

1 - Running

2 - Paused

3 - Suspended

10 - TemporaryMaintenance

phoneNumberstring nullable

The phone number assigned to the pearl.

totalAgentsinteger

The total number of agents allocated to the pearl.

createdstring date-time

The date and time when the pearl was created.

budgetConsumedinteger

The amount of budget consumed so far for the pearl.

totalTodayCallsinteger

The total number of calls made today for the pearl.

totalOngoingCallsinteger

The total number of ongoing calls for the pearl.

totalOnQueueinteger nullable

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

totalLeadsinteger nullable

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

totalLeadsCompletedinteger nullable

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

totalLeadsSuccessinteger nullable

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

budgetTotalinteger nullable

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

Changes

No recorded changes to this operation across all 1 revision of this API.