Get Pearls

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
  }
]

GET

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
  }
]

Authorization

string

header

required

Specify the authorization token.

For more information, check out the Authorization Guide.

List of all the pearls for the client.

string | null

The unique identifier of the pearl (project).

name

string | null

The name of the pearl (project).

createdAt

string<date-time>

The date and time when the pearl (project) was created.

type

integer<int32>

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

⌘I