Skip to navigation

Get Me

View as Markdown

Return the caller’s membership context for a firm.

Useful as a firm-scoped bootstrap endpoint.

Path params:

  • firm_slug (string)

Response:

  • firm (object)
  • membership (object) — includes role

Errors:

  • 401: Missing/invalid token
  • 403: Not a member of the firm
  • 404: Firm not found

Authentication

Authorizationstring
API Key authentication via header

Path parameters

firm_slugstringRequired3-64 characters

Response

Successful Response
dataobject
statusstringOptionalDefaults to success

Errors

422
Unprocessable Entity Error