Skip to content

API reference

Get authentication context

GET/v1/auth/context

Authorization

Send a personal API key or an OAuth access token as Authorization: Bearer <token>.

OAuth scopes, any one of: projects:read, projects:write, tasks:read, tasks:write, tools:execute, files:read, files:write, billing:read, integrations:read, automations:read, automations:write

Responses

200Success
  • credentialType"personal_api_key" | "oauth_access_token"required
  • userobjectrequired
  • idstringrequired
  • namestringrequired
  • emailstringrequired
  • teamobjectrequired
  • idstringrequired
  • slugstringrequired
  • scopes"projects:read" | "projects:write" | "tasks:read" | "tasks:write" | "tools:execute" | "files:read" | "files:write" | "billing:read" | "integrations:read" | "automations:read" | "automations:write"[]required
400Invalid request
  • errorobjectrequired
  • typestringrequired
  • messagestringrequired
  • requestIdstring
401Missing or invalid Bearer credential
  • errorobjectrequired
  • typestringrequired
  • messagestringrequired
  • requestIdstring
402Payment or subscription required
  • errorobjectrequired
  • typestringrequired
  • messagestringrequired
  • requestIdstring
403Credential is missing a required scope
  • errorobjectrequired
  • typestringrequired
  • messagestringrequired
  • requestIdstring
404Resource not found
  • errorobjectrequired
  • typestringrequired
  • messagestringrequired
  • requestIdstring
409Request conflict
  • errorobjectrequired
  • typestringrequired
  • messagestringrequired
  • requestIdstring
429Rate limit exceeded
  • errorobjectrequired
  • typestringrequired
  • messagestringrequired
  • requestIdstring
500Internal API error
  • errorobjectrequired
  • typestringrequired
  • messagestringrequired
  • requestIdstring