---
title: "List users"
method: GET
path: "/companies/{company}/users"
tags: ["Users"]
---

# List users

`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`

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`.

## Path parameters

- `company` string, uuid, required

## Query parameters

- `q` string, nullable
- `limit` integer
- `starting_after` string, uuid

## Headers

- `Factuarea-Version` string, date

## Response `200`

- object: Page of users (`{ data, has_more, next_cursor }`).
  - `data` object[], required: Items on the current page.
    - `id` string, uuid, required: UUID of the user.
    - `object` 'user', required: Stripe-like discriminator. Always `user` for this resource.
    - `name` string, required
    - `email` string, email, required
    - `initials` string, required: Initials shown in the avatar.
    - `avatar_color` string, required: Avatar color, stable per user.
  - `has_more` boolean, required: `true` when there are more objects after this page.
  - `next_cursor` string, 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`.

## Other responses

- `400`: `parameter_unknown` with `subcode` `retired_active_profile_header`: the retired `X-Active-Profile` header was sent; the company goes in the path. `parameter_invalid_format` on `Factuarea-Version`: the header is not a `YYYY-MM-DD` date. `unsupported_api_version`: the `Factuarea-Version` date is not a supported version.
- `401`: Missing or invalid API key.
- `403`: The request is authenticated but not allowed: the API key lacks the required scope (`insufficient_scope`), the plan does not include the public API or this feature (`addon_not_active`, `feature_not_available_in_plan`), or the module is not available with a test key (`module_not_available_in_sandbox`).
- `404`: The requested resource does not exist or belongs to another company. `profile_not_found`: the company in the path does not exist, is not in the API key scope or belongs to the other environment (live or test).
- `422`: Validation failed. The `error.param` field identifies which input is invalid.
- `429`: Rate limit exceeded. Retry after the duration in `Retry-After`.
- `500`: Unexpected server error.

---

[API](https://skmtc.dev/factuarea/apis/factuarea-public-api.md) · [All operations](https://skmtc.dev/factuarea/apis/factuarea-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/factuarea/apis/factuarea-public-api/revisions/718e77934422?raw)