Users

List users

List the people tasks can be assigned to in your company, ordered by name: its members plus people with operate access through an account relation.

  • View-only relation access is not listed; q filters by name or email.
  • Cursor-paginated: pass next_cursor as starting_after.
get/companies/{company}/users

Request

  • Base URL: https://api.factuarea.com/v1
  • URL: https://api.factuarea.com/v1/companies/{company}/users
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

companystring uuid required

Public identifier (UUID v7) of the company. Get it from GET /v1/me (data.scope[].id).

Query parameters

qstring nullable

Text matched against the member name or email, ignoring case and accents. Maximum 120 characters.

limitinteger

Number of users to return. Integer between 1 and 100. Defaults to 25.

starting_afterstring uuid

Cursor for forward pagination: the id of the last user of the previous page (the next_cursor you received). An id that is not in this list returns 422 invalid_param_value.

Headers

Factuarea-Versionstring date
Example:2026-06-01

Pin the API version (YYYY-MM-DD, Stripe-style date versioning) for this request; omit to use the key's pinned version, or the latest if none. Unsupported version → 400 unsupported_api_version; malformed → 400 parameter_invalid_format. The effective version is echoed in the Factuarea-Version response header. See the Versioning guide.

Response

has_moreboolean required

true when there are more objects after this page.

next_cursorstring nullable required

Value to pass as starting_after to get the next page (the id of the last object), or null when has_more is false.

Example response

{
  "data": [
    {
      "id": "0193a4f2-6b1c-7d3e-8a41-2c5e7f9a1b01",
      "object": "user",
      "name": "Ana Pérez",
      "email": "ana.perez@example.com",
      "initials": "AP",
      "avatar_color": "pink"
    }
  ]
}

Changes

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