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

Who am I

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

{
  "tokenType": "personal_key",
  "application": {
    "id": "string",
    "clientId": "sofia_app_live_3f9c…",
    "name": "Atelier CRM"
  },
  "user": {
    "id": "string"
  },
  "coverage": "workspace",
  "workspaces": [
    {
      "id": "string",
      "name": "Bistrot Lumière Lyon 2e"
    }
  ],
  "scopes": [
    "establishments:read"
  ],
  "mode": "test"
}

Who am I

curl --request GET \
  --url 'https://api.sofia-post.com/api/v1/me' \
  --header "Authorization: Bearer $SOFIA_API_KEY"

{
  "tokenType": "personal_key",
  "application": {
    "id": "string",
    "clientId": "sofia_app_live_3f9c…",
    "name": "Atelier CRM"
  },
  "user": {
    "id": "string"
  },
  "coverage": "workspace",
  "workspaces": [
    {
      "id": "string",
      "name": "Bistrot Lumière Lyon 2e"
    }
  ],
  "scopes": [
    "establishments:read"
  ],
  "mode": "test"
}

Your first call

Send the key in the Authorization header. GET /v1/me tells you who the key acts for, its Workspaces and its permissions.

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

{
  "tokenType": "personal_key",
  "user": { "id": "cmo7qiltc0000sb1p7zdx1aw4" },
  "coverage": "account",
  "workspaces": [{ "id": "cmo7qiltc0000sb1p7zdx1aw4", "name": "160 food" }],
  "scopes": ["establishments:read", "posts:read", "posts:write"],
  "mode": "live",
  "expiresAt": "2026-11-09T20:09:05.644Z"
}

No key yet? Create one in Settings › API › Personal access: see Authentication.

Authorizations

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

Response

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

Was this page helpful?