Platform API reference

Platform API · Introspect

get/v1/introspectAuth

Introspect current user with workspace list

Response · 200

is_authenticated*boolean

False for an anonymous caller and for an access token whose session has been signed out.

principalobject

The authenticated caller, or `null` when the request carries no valid session.

accountobject

The caller's account profile, or `null` when not authenticated.

workspacesarray

Workspaces the caller is a member of (empty when not authenticated).

Example

Request

GET https://api.platform-auth.productcraft.co/v1/introspect
Authorization: Bearer YOUR_TOKEN

Response

{
  "is_authenticated": false,
  "principal": {},
  "account": {},
  "workspaces": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "slug": "string",
      "display_name": "string",
      "role": "owner",
      "services": [
        "mail",
        "waitlist"
      ],
      "avatar_url": "string"
    }
  ]
}