Skip to navigation

List Members

View as Markdown

List firm members.

Requires that the authenticated user is a member of the firm.

Path params:

  • firm_slug (string)

Response:

  • members (array)
    • membership (object)
    • user_email (string)
    • user_name (string | null)

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