v1

latestOpenAPI 3.0.02026-07-2422987517.5 KB

User

List users

Returns the list of users visible to the caller. For a normal user this is scoped to their own account only; Cardda staff see all users. Each item is augmented with computed methods (milestone_ids, n_companies, company_role, capability flags, plh_profile_complete, missing_plh_profile_fields, needs_password_setup).

This endpoint is not company-scoped — visibility comes from the user policy, not the company-id header.

get/v1/users

Query parameters

_startinteger

If all the transactions where in an array, this would represent the index of the first item returned in the response

_endinteger

If all the transactions where in an array, this would represent the index of the last item returned in the response

_order'asc' | 'desc'

The order method, which can be ascending or descending

_fieldstring

Example:created_at

The field used to sort, the example illustrates a response that would be sorted by the creation date

Headers

company-idstring uuid required

UUID of the company on whose behalf the request is made. Required for every Organization endpoint. See The company-id header for details on how to obtain a value for this header and the error responses to expect when it is missing or invalid.

Response

Paginated list of users.

idstring required

Firebase UID.

first_namestring nullable

last_namestring nullable

emailstring nullable

phoneinteger nullable

identifierstring nullable

Tax id / national id of the user.

countrystring nullable

nationalitystring nullable

addressstring nullable

occupationstring nullable

genderinteger nullable

birthdatestring date-time nullable

is_pepboolean

Whether the user is a politically exposed person.

legal_addressobject nullable

user_typestring nullable

statusstring

terms_acceptedboolean

legal_representativeboolean nullable

has_powers_to_actboolean nullable

whatsapp_verifiedboolean

milestone_idsstring[]

Computed list of milestone ids reached by the user.

n_companiesinteger

Number of companies the user belongs to (computed).

company_rolestring nullable

The user's role in the current company context (computed).

plh_profile_completeboolean

Whether the user's PLH profile is complete (computed; serialized as plh_profile_complete?).

missing_plh_profile_fieldsstring[]

needs_password_setupboolean

Whether the user still needs to set a password (computed; serialized as needs_password_setup?).

created_atstring date-time

updated_atstring date-time

Example response

[
  {
    "user_type": "business",
    "status": "pending"
  }
]