Skip to main content
GET
/
v2
/
Pearl
Get Pearls
curl --request GET \
  --url https://api.nlpearl.ai/v2/Pearl \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "<string>",
    "name": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "type": 123,
    "status": 123,
    "created": "2023-11-07T05:31:56Z"
  }
]

Authorizations

​
Authorization
string
header
required

Specify the authorization token.

For more information, check out the Authorization Guide.

Response

List of all the pearls for the client.

​
id
string | null
​
name
string | null
​
createdAt
string<date-time>
​
type
integer

1 - Inbound

2 - Outbound

​
status
integer

Here is the activity status

1 - Running

2 - Paused

3 - Suspended

10 - TemporaryMaintenance

​
created
string<date-time>