API reference

Me

Who am I? Resolves the authenticated actor, the active org, and the credential mode — the first call to make when wiring up a client.

Attributes

  • objectstringrequired
  • actorobjectrequired
  • orgobjectrequired
  • modestringrequired

    Possible values: live, test

  • scopesarray of stringrequired

Get the current context

GET/v1/me

Returns the actor, organization, and mode resolved from the credential. Use it to confirm a key is valid and see which org it acts on.

Requires an API key (bearer), scoped to the active org.

Returns

  • 200The resolved request context.

Failures use the standard error envelope with a closed set of codes.