Pearl

Get Pearls

Retrieves all Pearls

get/v2/Pearl

Request

Base URL
https://api.nlpearl.ai
Auth
HTTP bearer
TypeScript
https://skmtc.dev/nlpearl/apis/nlpearl-client-api/docs/v2/Pearl/get.ts
A function with typed inputs. Its response is checked against the schema.

List of all the pearls for the client.

idstring nullable

The unique identifier of the pearl.

namestring nullable

The name of the pearl.

createdAtstring date-time

The date and time when the pearl was created.

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

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