Developers API reference Version 1 · generated from the code openapi.json
Routes

account

Who the credential acts as

GET /api/v1/me

The account behind the credential and the scopes it may exercise.

An organisation token answers with kind: organisation: it acts for the organisation, not for a person. Any valid credential may call this, whatever its scopes.

Response

200 Me

  • id integer

    Id of the account the credential acts as.

  • name string

    Its name, or its address when it has none.

  • kind string

    organisation for an organisation token, user otherwise.

  • organisation_id integer or null

    Id of the organisation of the account; null when it has none.

  • scopes array of string

    The scopes the credential may exercise right now.

Errors

  • 401

    No valid credential.

  • 403

    The credential lacks the required scope, or the account may not do this.

planner_banner_ad_pt