Skip to main content
GET
Get Pearls

Authorizations

Authorization
string
header
required

Specify the authorization token in the form AccountId:SecretKey, or an OAuth 2.0 access token.

For more information, check out the Authorization Guide and the OAuth 2.0 Guide.

Response

List of all the pearls for the client.

id
string | null

The unique identifier of the pearl.

name
string | null

The name of the pearl.

createdAt
string<date-time>

The date and time when the pearl was created.

type
integer<int32> | null

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