Get user info

GET 
/user/info

Returns user information.

Cost: 0 credit per call.

Request

Header Parameters

X-Exorde-Api-Version stringrequired

Possible values: [v1]

The API version.

Responses

200

OK

application/json

Schema

Schema

user objectrequired

A User resource.

id uuidrequired

Possible values: Value must match regular expression ^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$

The user id

email email

The user email.

plan object

The user subscription plan

name stringrequired

The plan name.

totalMonthlyCredits int32required

The total of credits allowed for the current month.

remainingMonthlyCredits int32required

The total of credits remaining for the current month.

maxAdditionalCredits int32

The maximum of additional credits allowed for the current month.

remainingAdditionalCredits int32

The total of additional credits remaining for the current month.

createdAt date-timerequired

The creation date of the user. It respect RFC3339 format, UTC date-time without timezone.

updatedAt date-timerequired

The last date when the user was updated. It respect RFC3339 format, UTC date-time without timezone.

status objectrequired

cost int32required

Number of credits that were consumed for this request.

apiDeprecationNotice object

Deprecation notice of the API.

message stringrequired

A message that tells when the API version will be shut down.

shutdownDate date-timerequired

The date of removal of the API version, UTC date-time without timezone using RFC3339 format.

Example (from schema)

{
  "user": {
    "id": "123e4567-e89b-12d3-a456-426655440000",
    "email": "[email protected]",
    "plan": {
      "name": "string",
      "totalMonthlyCredits": 0,
      "remainingMonthlyCredits": 0,
      "maxAdditionalCredits": 0,
      "remainingAdditionalCredits": 0
    },
    "createdAt": "1977-04-22T07:00:00.000Z",
    "updatedAt": "1977-04-22T07:00:00.000Z"
  },
  "status": {
    "cost": 0,
    "apiDeprecationNotice": {
      "message": "The version 1 of the API is deprecated and will be shut down the 2022-02-02 at 00:00:00 UTC.",
      "shutdownDate": "2022-02-02T00:00:00.000Z"
    }
  }
}

400

Bad Request

application/json

Schema

Schema

error objectrequired

message stringrequired

The description of the error. It gives meaningful information about what happened.

code integerrequired

Possible values: >= 100 and <= 600

The error code. Please use our documentation to get more information about it.

userId uuid

Possible values: Value must match regular expression ^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$

The id of the user that made the request.

requestId uuid

Possible values: Value must match regular expression ^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$

The id of the request.

status objectrequired

cost int32required

Number of credits that were consumed for this request.

apiDeprecationNotice object

Deprecation notice of the API.

message stringrequired

A message that tells when the API version will be shut down.

shutdownDate date-timerequired

The date of removal of the API version, UTC date-time without timezone using RFC3339 format.

Example (from schema)

{
  "error": {
    "message": "An error occurred.",
    "code": 0,
    "userId": "123e4567-e89b-12d3-a456-426655440000",
    "requestId": "123e4567-e89b-12d3-a456-426655440000"
  },
  "status": {
    "cost": 0,
    "apiDeprecationNotice": {
      "message": "The version 1 of the API is deprecated and will be shut down the 2022-02-02 at 00:00:00 UTC.",
      "shutdownDate": "2022-02-02T00:00:00.000Z"
    }
  }
}

401

Unauthorized

application/json

Schema

Schema

error objectrequired

message stringrequired

The description of the error. It gives meaningful information about what happened.

code integerrequired

Possible values: >= 100 and <= 600

The error code. Please use our documentation to get more information about it.

userId uuid

Possible values: Value must match regular expression ^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$

The id of the user that made the request.

requestId uuid

Possible values: Value must match regular expression ^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$

The id of the request.

status objectrequired

cost int32required

Number of credits that were consumed for this request.

apiDeprecationNotice object

Deprecation notice of the API.

message stringrequired

A message that tells when the API version will be shut down.

shutdownDate date-timerequired

The date of removal of the API version, UTC date-time without timezone using RFC3339 format.

Example (from schema)

{
  "error": {
    "message": "An error occurred.",
    "code": 0,
    "userId": "123e4567-e89b-12d3-a456-426655440000",
    "requestId": "123e4567-e89b-12d3-a456-426655440000"
  },
  "status": {
    "cost": 0,
    "apiDeprecationNotice": {
      "message": "The version 1 of the API is deprecated and will be shut down the 2022-02-02 at 00:00:00 UTC.",
      "shutdownDate": "2022-02-02T00:00:00.000Z"
    }
  }
}

403

Forbidden

application/json

Schema

Schema

error objectrequired

message stringrequired

The description of the error. It gives meaningful information about what happened.

code integerrequired

Possible values: >= 100 and <= 600

The error code. Please use our documentation to get more information about it.

userId uuid

Possible values: Value must match regular expression ^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$

The id of the user that made the request.

requestId uuid

Possible values: Value must match regular expression ^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$

The id of the request.

status objectrequired

cost int32required

Number of credits that were consumed for this request.

apiDeprecationNotice object

Deprecation notice of the API.

message stringrequired

A message that tells when the API version will be shut down.

shutdownDate date-timerequired

The date of removal of the API version, UTC date-time without timezone using RFC3339 format.

Example (from schema)

{
  "error": {
    "message": "An error occurred.",
    "code": 0,
    "userId": "123e4567-e89b-12d3-a456-426655440000",
    "requestId": "123e4567-e89b-12d3-a456-426655440000"
  },
  "status": {
    "cost": 0,
    "apiDeprecationNotice": {
      "message": "The version 1 of the API is deprecated and will be shut down the 2022-02-02 at 00:00:00 UTC.",
      "shutdownDate": "2022-02-02T00:00:00.000Z"
    }
  }
}

429

Too Many Requests

application/json

Schema

Schema

error objectrequired

message stringrequired

The description of the error. It gives meaningful information about what happened.

code integerrequired

Possible values: >= 100 and <= 600

The error code. Please use our documentation to get more information about it.

userId uuid

Possible values: Value must match regular expression ^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$

The id of the user that made the request.

requestId uuid

Possible values: Value must match regular expression ^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$

The id of the request.

status objectrequired

cost int32required

Number of credits that were consumed for this request.

apiDeprecationNotice object

Deprecation notice of the API.

message stringrequired

A message that tells when the API version will be shut down.

shutdownDate date-timerequired

The date of removal of the API version, UTC date-time without timezone using RFC3339 format.

Example (from schema)

{
  "error": {
    "message": "An error occurred.",
    "code": 0,
    "userId": "123e4567-e89b-12d3-a456-426655440000",
    "requestId": "123e4567-e89b-12d3-a456-426655440000"
  },
  "status": {
    "cost": 0,
    "apiDeprecationNotice": {
      "message": "The version 1 of the API is deprecated and will be shut down the 2022-02-02 at 00:00:00 UTC.",
      "shutdownDate": "2022-02-02T00:00:00.000Z"
    }
  }
}

500

Internal Server Error

application/json

Schema

Schema

requestId uuid

Possible values: Value must match regular expression ^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$

The id of the request.

Example (from schema)

{
  "requestId": "123e4567-e89b-12d3-a456-426655440000"
}

503

Service Unavailable

Loading...