Skip to navigation

Get Firm

View as Markdown

Get firm details by slug.

Anonymous requests receive public branding fields for login screens. Authenticated requests require firm membership and receive full details.

Path params:

  • firm_slug (string)

Anonymous response:

  • id (int)
  • name (string)
  • slug (string)
  • logo_url (string | null)

Authenticated member response:

  • Full firm profile

Errors:

  • 401: 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