agents

Returns one agent of the authenticated account.

get/api/agents/{uuid}

Request

  • Base URL: https://api.pricklymails.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.pricklymails.com/api/agents/{uuid}
  • Auth: HTTP bearer

Path parameters

uuidstring required

Public UUID of the agent.

Response

The requested agent.

created_atstring required

RFC 3339 creation timestamp.

descriptionstring nullable

Description of the agent, omitted when none was set.

is_activeboolean required

Whether the agent can currently authenticate.

namestring required

Display name of the agent.

scopesstring[] required

Scopes granted to the agent.

statusstring required

Status of the agent: "active" or "revoked".

updated_atstring required

RFC 3339 timestamp of the last change.

uuidstring required

Public UUID of the agent.

Changes

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