Identity

Get authenticated user and workspace context

get/api/v1/whoami

Request

  • Base URL: https://www.poster.ly
  • URL: https://www.poster.ly/api/v1/whoami
  • Auth: HTTP bearer

Response

Identity fetched successfully

workspace_id_requiredboolean

True when calls that need a workspace must pass workspace_id.

Example response

{
  "user": {
    "id": "user_123",
    "email": "founder@example.com"
  },
  "api_key": {
    "id": "key_123",
    "scopes": [
      "accounts:read",
      "accounts:write",
      "posts:write"
    ]
  },
  "default_workspace": {
    "id": "2d0a6d4c-9eef-4ee2-9026-2ca0dc29c8d6",
    "name": "Grassroots",
    "is_personal": false
  },
  "workspaces": [
    {
      "id": "2d0a6d4c-9eef-4ee2-9026-2ca0dc29c8d6",
      "name": "Grassroots",
      "is_personal": false
    }
  ]
}

Changes

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