GET
/
v1
/
Account
curl --request GET \
  --url https://api.nlpearl.ai/v1/Account \
  --header 'Authorization: Bearer <token>'
{
  "name": "<string>",
  "totalAgents": 123,
  "creditBalance": 123,
  "status": 123,
  "remainingMinutes": 123
}

Authorizations

​
Authorization
string
header
required

Specify the authorization token.

For more information, check out the Authorization Guide.

Response

200
text/plain
Client informations
​
name
string | null

The name of the client.

​
totalAgents
integer

The total number of agents.

​
creditBalance
number

The current credit balance.

​
status
integer

Represents the authorization status for making calls.

1 - FullAccess

2 - LimitedAccess

3 - NoCredits

4 - SuspendedAccount

5 - DebtReached

​
remainingMinutes
number

The remaining minutes available.