---
title: "Get all Users"
method: GET
path: "/v2/users"
tags: ["Users"]
---

# Get all Users

`GET /v2/users`

| ⚠️  This endpoint is currently in BETA |
|--|

Paginate through internal Users in your organization.

Returns information about each User, including name, primary email address, all email
addresses, photo URL, account status, and account role.

The `emailAddresses` and `role` properties are only returned to callers with the "Manage
Users" [permission](/pages/external-api-v2/permissions).

Use the optional `term` parameter to filter by first name, last name, or primary email address.

You can also filter users using the `filter` query parameter. The filter parameter is a string
that you can specify conditions based on the following properties.
| **Property Name** | **Type** | **Allowed Operators** | **Examples** |
|---|---|---|---|
| `id` | `int32` | `=` | `id=1\|id=2\|id=3` |
| `status` | `enum` | `=` | `status=active` |

## Query parameters

- `cursor` string
- `limit` integer
- `term` string
- `filter` string

## Response `200`

OK

- UserDataPaged — A paginated list of Users
  - `data` UserData[], required — A page of UserData results
    - `id` integer, required — The user's unique identifier
    - `firstName` string, required — The user's first name
    - `lastName` string, nullable, required — The user's last name
    - `primaryEmailAddress` string, email, nullable, required — The user's primary email address
    - `emailAddresses` string[] — All of the user's email addresses. Only returned when the authenticated user has the "Manage Users" [permission](/pages/external-api-v2/permissions).
    - `photoUrl` string, uri, nullable, required — URL of the user's profile photo
    - `status` 'active' | 'invited' | 'deactivated', required — The user's account status. - `active`: the user can sign in and use Affinity. - `invited`: the user has been invited to the product but has not yet accepted the invitation and thus cannot have taken any actions. - `deactivated`: the user was once active but has been deactivated and can no longer use the product.
    - `role` string — The user's account role. Only returned when the authenticated user has the "Manage Users" [permission](/pages/external-api-v2/permissions).
  - `pagination` Pagination, required
    - `prevUrl` string, uri, nullable — URL for the previous page
    - `nextUrl` string, uri, nullable — URL for the next page

## Other responses

- `400` — Bad Request
- `403` — Forbidden
- `default` — Errors

---

[API](https://skmtc.net/affinity/apis/affinity-api-v2.md) · [All operations](https://skmtc.net/affinity/apis/affinity-api-v2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/affinity/affinity-api-v2/revisions/4c2891c31b7f/schema)