---
title: "List users"
method: GET
path: "/users"
tags: ["Users"]
---

# List users

`GET /users`

## Request

- Base URL: `https://api.parley.so/v1`
- URL: `https://api.parley.so/v1/users`
- Auth: HTTP bearer

List the people in your organization, newest first by default. A user's id is what a project's access.memberIds, a task's assigneeId, and a field of type user take.

## Query parameters

- `search` string: Case-insensitive. Every word must appear in the user's first name, last name, or email.
- `role` 'owner' | 'admin' | 'member' | 'parley': Only users with this role.
- `sort` 'email' | '-email' | 'createdAt' | '-createdAt': Sort order: a field name, prefixed with - for descending. Defaults to -createdAt.
- `cursor` string: Opaque cursor from nextCursor. Pass the same filters and sort. Omit for the first page.
- `limit` integer: Maximum number of items to return.

## Response `200`

OK

- object
  - `data` User[], required
    - `id` string, required: The user ID.
    - `email` string, required: The user's email address.
    - `firstName` string, nullable, required: First name, or null if unset.
    - `lastName` string, nullable, required: Last name, or null if unset.
    - `role` 'owner' | 'admin' | 'member' | 'parley', required: The user's role in the organization. Owners and admins can manage organization settings, such as fields and organization skills; members can't. parley is Parley staff, listed only for other Parley staff.
    - `active` boolean, required: Whether the user can sign in. A disabled or locked user is inactive and can't be set as the value of a field of type user.
    - `createdAt` string, date-time, required: When the user's Parley account was created, which can be before they joined the organization.
  - `nextCursor` string, nullable, required: Cursor for the next page, or null on the last page.

## Other responses

- `400`: The request was invalid. VALIDATION_FAILED, INVALID_CURSOR.
- `401`: Missing or invalid credentials. UNAUTHORIZED.
- `403`: You don't have permission. FORBIDDEN.
- `429`: Too many requests, or a usage limit was reached. TOO_MANY_REQUESTS.

---

[API](https://skmtc.dev/parley/apis/parley-api.md) - [All operations](https://skmtc.dev/parley/apis/parley-api/llms.txt) - [OpenAPI document](https://skmtc.dev/parley/apis/parley-api/revisions/6b78aeee07bc?raw)