> ## Documentation Index
> Fetch the complete documentation index at: https://docs.parley.so/llms.txt
> Use this file to discover all available pages before exploring further.

# List users

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



## OpenAPI

````yaml https://api.parley.so/openapi.json get /users
openapi: 3.1.1
info:
  title: Parley API
  version: 1.0.0
  description: >-
    Manage Parley's projects (matters or cases), accounts (client
    organizations), contacts (people), tasks, custom fields, notes, files,
    activity, automations, and skills. Records refer to each other as { type,
    id, name } references; writes take IDs. Errors are { error: { code, message,
    details } }, where code names what went wrong and each operation lists the
    codes it can return. In a query string, write a timestamp's offset as Z or
    %2B, because a raw + arrives as a space. The MCP server at /mcp offers the
    same data as a smaller set of tools.
servers:
  - url: https://api.parley.so/v1
security:
  - bearerAuth: []
tags:
  - name: Projects
    description: >-
      A project is a matter or case: it groups the files, notes, activity, and
      tasks for one engagement, and links to the accounts and contacts it
      involves.
  - name: Accounts
    description: >-
      An account is a client organization. Contacts belong to it, and projects
      link to it.
  - name: Contacts
    description: >-
      A contact is a person, optionally belonging to one account and linked to
      projects.
  - name: Tasks
    description: >-
      A task is a to-do with a status, assignee, and due date, optionally about
      one project, account, or contact.
  - name: Fields
    description: >-
      Custom fields defined for projects, accounts, contacts, or tasks. Records
      carry their values in fields, keyed by field name.
  - name: Notes
    description: >-
      Markdown notes on a project, account, or contact. Updates take the version
      you last read, so concurrent edits fail with 409 VERSION_CONFLICT instead
      of overwriting.
  - name: Files
    description: >-
      Files and folders of a project, account, contact, or intake, or the
      organization's Library. Add a file by creating an upload, PUTting its
      bytes, and adding the upload to a location.
  - name: Activity
    description: >-
      What happened across the organization or on one record: changes, links,
      notes, files, USCIS case updates, and synced emails and meetings. Each
      item's kind says which details it carries.
  - name: Sessions
    description: >-
      Conversations with Parley's assistant, from the web app, Word, Outlook,
      automation runs, and the API. Start one with a message, follow up or steer
      it while it works, and read its replies.
  - name: Automations
    description: >-
      Instructions Parley's assistant carries out on a schedule, as the person
      who created them, with nobody present.
  - name: Skills
    description: >-
      Reusable playbooks for Parley's assistant: a SKILL.md plus optional
      bundled documents, addressed by slug.
  - name: Users
    description: The people in your organization, and the caller.
paths:
  /users:
    get:
      tags:
        - Users
      summary: List users
      description: >-
        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.
      operationId: listUsers
      parameters:
        - name: search
          in: query
          schema:
            type: string
            minLength: 1
            description: >-
              Case-insensitive. Every word must appear in the user's first name,
              last name, or email.
          allowEmptyValue: true
          allowReserved: true
        - name: role
          in: query
          schema:
            enum:
              - owner
              - admin
              - member
              - parley
            type: string
            description: Only users with this role.
          allowEmptyValue: true
          allowReserved: true
        - name: sort
          in: query
          schema:
            enum:
              - email
              - '-email'
              - createdAt
              - '-createdAt'
            type: string
            default: '-createdAt'
            description: >-
              Sort order: a field name, prefixed with - for descending. Defaults
              to -createdAt.
          allowEmptyValue: true
          allowReserved: true
        - name: cursor
          in: query
          schema:
            type: string
            minLength: 1
            description: >-
              Opaque cursor from nextCursor. Pass the same filters and sort.
              Omit for the first page.
          allowEmptyValue: true
          allowReserved: true
        - name: limit
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 250
            default: 50
            description: Maximum number of items to return.
          allowEmptyValue: true
          allowReserved: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/User'
                  nextCursor:
                    anyOf:
                      - type: string
                      - type: 'null'
                    description: Cursor for the next page, or null on the last page.
                required:
                  - data
                  - nextCursor
        '400':
          description: The request was invalid. VALIDATION_FAILED, INVALID_CURSOR.
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ValidationFailedError'
                  - $ref: '#/components/schemas/InvalidCursorError'
        '401':
          description: Missing or invalid credentials. UNAUTHORIZED.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedError'
        '403':
          description: You don't have permission. FORBIDDEN.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '429':
          description: Too many requests, or a usage limit was reached. TOO_MANY_REQUESTS.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsError'
components:
  schemas:
    User:
      type: object
      properties:
        id:
          type: string
          minLength: 1
          description: The user ID.
        email:
          type: string
          description: The user's email address.
        firstName:
          anyOf:
            - type: string
            - type: 'null'
          description: First name, or null if unset.
        lastName:
          anyOf:
            - type: string
            - type: 'null'
          description: Last name, or null if unset.
        role:
          enum:
            - owner
            - admin
            - member
            - parley
          type: string
          description: >-
            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:
          type: boolean
          description: >-
            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:
          type: string
          format: date-time
          description: >-
            When the user's Parley account was created, which can be before they
            joined the organization.
      required:
        - id
        - email
        - firstName
        - lastName
        - role
        - active
        - createdAt
    ValidationFailedError:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              const: VALIDATION_FAILED
            message:
              type: string
              examples:
                - The request is invalid.
            details:
              type: object
              properties:
                issues:
                  type: array
                  items:
                    type: object
                    properties:
                      path:
                        type: string
                        description: >-
                          Where the problem is, as a dotted path into the input
                          such as accountIds.add.0 or reminder.remindAt. Empty
                          for the input as a whole.
                      message:
                        type: string
                        description: What is wrong with the value.
                    required:
                      - path
                      - message
                  description: Each problem with the input.
              required:
                - issues
          required:
            - code
            - message
            - details
      required:
        - error
    InvalidCursorError:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              const: INVALID_CURSOR
            message:
              type: string
              examples:
                - >-
                  The cursor is invalid, or was issued for different filters or
                  sort.
          required:
            - code
            - message
      required:
        - error
    UnauthorizedError:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              const: UNAUTHORIZED
            message:
              type: string
              examples:
                - Missing or invalid credentials.
          required:
            - code
            - message
      required:
        - error
    ForbiddenError:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              const: FORBIDDEN
            message:
              type: string
              examples:
                - You don't have permission to do this.
          required:
            - code
            - message
      required:
        - error
    TooManyRequestsError:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              const: TOO_MANY_REQUESTS
            message:
              type: string
              examples:
                - Too many requests.
          required:
            - code
            - message
      required:
        - error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: A Parley API key.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.