AccountWho am I
Back to Sofia

Account

Who am I

Describes the calling token: its kind, application, the person it acts for, their Workspaces, scopes, mode and expiry. Any valid token can read it.

GEThttps://api.sofia-post.com/api/v1/me
GET/v1/me
curl -X GET 'https://api.sofia-post.com/api/v1/me' \
  -H "Authorization: Bearer $SOFIA_API_KEY"

Authorizations

  • Authorizationstringrequired

    Your personal key or OAuth access token, sent as Bearer <token>.

Response

200application/json

The identity and scope of the calling token.

  • tokenTypestringrequired

    Kind of token: personal_key, authorization_code or client_credentials

    Allowed values: personal_keyauthorization_codeclient_credentials

  • applicationobjectrequired

    The application behind the token

    Show child attributes
    • idstringrequired

      Identifier of the application (or of the personal key)

    • clientIdstringrequired

      The client_id of the application

    • namestringrequired

      Name of the application

  • userobjectrequired

    The person the token acts for

    Show child attributes
    • idstringrequired

      The person the token acts for: the author of the key, or who granted consent

  • coveragestringrequired

    workspace: one Workspace; account: all those the key author belongs to

    Allowed values: workspaceaccount

  • workspacesobject[]required

    Where the token acts now

    Show child attributes
    • idstringrequired

      Identifier of the Workspace

    • namestringrequired

      Named after its active establishments

  • scopesstring[]required

    Scopes held by the token

  • modestringrequired

    test or live

    Allowed values: testlive

  • expiresAtstring<date-time>

    When the token expires; absent for a key without expiry

4XXapplication/json

Any other error, in the error envelope.