Get Account - NLPearl Documentation

GET

Account

Get Account

curl --request GET \
  --url https://api.nlpearl.ai/v1/Account \
  --header 'Authorization: Bearer <token>'

{
  "name": "<string>",
  "totalAgents": 123,
  "creditBalance": 123,
  "status": 123
}

Authorization

string

header

required

Specify the authorization token.

For more information, check out the Authorization Guide.

Client information

name

string | null

The name of the client.

totalAgents

integer<int32>

The total number of agents.

creditBalance

number<double>

The current credit balance.

status

integer<int32>

Represents the authorization status for making calls.

1 - FullAccess

2 - LimitedAccess

3 - NoCredits

4 - SuspendedAccount

5 - DebtReached

Get Account

curl --request GET \
  --url https://api.nlpearl.ai/v1/Account \
  --header 'Authorization: Bearer <token>'

{
  "name": "<string>",
  "totalAgents": 123,
  "creditBalance": 123,
  "status": 123
}