---
title: "Get Pearl"
method: GET
path: "/v2/Pearl/{pearlId}"
tags: ["Pearl"]
---

# Get Pearl

`GET /v2/Pearl/{pearlId}`

Retrieves a specific Pearl by its ID

## Path parameters

- `pearlId` string, required

## Response `200`

Details of the specific Pearl.

- ProjectApiView
  - `id` string, nullable — The unique identifier of the pearl.
  - `name` string, nullable — The name of the pearl.
  - `type` integer — Defines the type of activity of the pearl. `1 - Inbound` `2 - Outbound`
  - `status` integer — Here is the activity status `1 - Running` `2 - Paused` `3 - Suspended` `10 - TemporaryMaintenance`
  - `phoneNumber` string, nullable — The phone number assigned to the pearl.
  - `totalAgents` integer — The total number of agents allocated to the pearl.
  - `created` string, date-time — The date and time when the pearl was created.
  - `budgetConsumed` integer — The amount of budget consumed so far for the pearl.
  - `totalTodayCalls` integer — The total number of calls made today for the pearl.
  - `totalOngoingCalls` integer — The total number of ongoing calls for the pearl.
  - `totalOnQueue` integer, nullable — The number of calls currently waiting in the queue (inbound only).
  - `totalLeads` integer, nullable — The total number of leads associated with the pearl (outbound only).
  - `totalLeadsCompleted` integer, nullable — The total number of leads that have been completed (outbound only).
  - `totalLeadsSuccess` integer, nullable — The total number of leads successfully converted (outbound only).
  - `budgetTotal` integer, nullable — The total budget allocated for the pearl (outbound only).

## Other responses

- `400` — Error

---

[API](https://skmtc.net/nlpearl/apis/nlpearl-client-api.md) · [All operations](https://skmtc.net/nlpearl/apis/nlpearl-client-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nlpearl/nlpearl-client-api/versions/52d64fc5d6e9/schema)