account
Get account Identity, credit balance, and the credential making the call. Call this first: one request tells you what this credential is allowed to do.
GET /v1/account
Call this first. It identifies the workspace and reports what this credential
can actually do, so you never have to discover a limit by hitting it.
Requires account:read. It changes nothing and costs no credits. Read
capabilities to find out whether a feature is live rather than inferring it
from a version number: that is how an integration written today keeps working
when a capability ships.
Authorizations Authorizationbearer in header required
Retrieve the authenticated workspace
dataobject required
Show child attributes data. workspaceobject required
Show child attributes data.workspace. idstring required
data.workspace. namestring required
data.workspace. slugstring required
data. credit_balanceinteger required range: -9007199254740991–9007199254740991
data. credentialobject required
Show child attributes data.credential. idstring required
data.credential. kindenum<string> required one of: api_key, oauth
data.credential. namestringnull required
data.credential. prefixstring required
data.credential. scopesenum<string>[] required
data.credential. created_atstring required
data.credential. expires_atstringnull required
data. capabilitiesobject required
Show child attributes data.capabilities. webhooksboolean required
Possible codes: invalid_request, unknown_field, invalid_parameter, invalid_cursor
errorobject required
Show child attributes error. messagestring required
error. docs_urlstring required
error. action_urlstring<uri>
error. detailsRecord<string, object>
Possible codes: authentication_required, invalid_api_key, api_key_expired, api_key_revoked
errorobject required
Show child attributes error. messagestring required
error. docs_urlstring required
error. action_urlstring<uri>
error. detailsRecord<string, object>
Possible codes: insufficient_credits
errorobject required
Show child attributes error. messagestring required
error. docs_urlstring required
error. action_urlstring<uri>
error. detailsRecord<string, object>
Possible codes: insufficient_scope, feature_not_available, admin_required
errorobject required
Show child attributes error. messagestring required
error. docs_urlstring required
error. action_urlstring<uri>
error. detailsRecord<string, object>
Possible codes: resource_not_found
errorobject required
Show child attributes error. messagestring required
error. docs_urlstring required
error. action_urlstring<uri>
error. detailsRecord<string, object>
Possible codes: conflict, result_not_ready, idempotency_key_reused
errorobject required
Show child attributes error. messagestring required
error. docs_urlstring required
error. action_urlstring<uri>
error. detailsRecord<string, object>
Possible codes: result_expired
errorobject required
Show child attributes error. messagestring required
error. docs_urlstring required
error. action_urlstring<uri>
error. detailsRecord<string, object>
Possible codes: request_too_large
errorobject required
Show child attributes error. messagestring required
error. docs_urlstring required
error. action_urlstring<uri>
error. detailsRecord<string, object>
Possible codes: request_too_large_for_plan
errorobject required
Show child attributes error. messagestring required
error. docs_urlstring required
error. action_urlstring<uri>
error. detailsRecord<string, object>
Possible codes: rate_limited
errorobject required
Show child attributes error. messagestring required
error. docs_urlstring required
error. action_urlstring<uri>
error. detailsRecord<string, object>
Possible codes: internal_error
errorobject required
Show child attributes error. messagestring required
error. docs_urlstring required
error. action_urlstring<uri>
error. detailsRecord<string, object>
Possible codes: service_unavailable
errorobject required
Show child attributes error. messagestring required
error. docs_urlstring required
error. action_urlstring<uri>
error. detailsRecord<string, object>