me

Get Me

Changed on

Return identity, workspace, and scopes of the calling API key.

get/v1/me

Request

  • Base URL: https://api.topo.io
  • URL: https://api.topo.io/v1/me
  • Auth: HTTP bearer

Response

Successful Response

idstring uuid required

Unique identifier of the API key.

organization_idstring uuid required

Workspace the key belongs to.

organization_namestring required

Workspace display name.

namestring required

Name of the key.

user_idstring uuid nullable required

User who issued the key, when it was issued by a person. Null for a key created without a user.

key_prefixstring required

Leading characters of the raw key, safe to display.

scopesstring[] required

Permissions granted to this key.

last_used_atstring date-time nullable required

When the key was last used to make a request.

created_atstring date-time required

When the key was issued.

Changes

  • ad6ac1d13526Revision changes
    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status