CAcardda
Company membership

List company memberships

Returns the memberships of a company (users and pending email invitations), each including its permissions (id and name only). The company is resolved from the company_id request parameter; the caller only sees memberships of companies where they hold the members_management permission (Cardda staff see all).

get/v1/company_memberships

Request

  • Base URL
    https://api.cardda.com
  • URL
    https://api.cardda.com/v1/company_memberships
  • Auth
    HTTP bearer

Query parameters

company_idstring uuid required

UUID of the company whose memberships are listed.

Parameters

#/paths/~1v1~1users/get/parameters/0 (unresolved $ref)

Response

Paginated list of company memberships.

idstring uuid required
user_idstring nullable

Firebase UID of the member. Null while the invitation is still pending.

company_idstring uuid required
emailstring nullable
rolestring

Role name (e.g. owner, admin, member, or a custom company role name).

status'pending' | 'active' | 'canceled'
legal_representativeboolean
has_powers_to_actboolean nullable
partnerboolean
partner_typeinteger nullable
participation_ratenumber nullable

Ownership participation percentage (0-100).

is_indirect_participation_corporateboolean nullable
company_role_idstring uuid nullable
created_atstring date-time
updated_atstring date-time

Example response

[
  {
    "role": "member",
    "status": "active"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.