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

# List users

> Returns users for the org. The response object includes the user list under the `users` key along with metadata. The top-level `id` is the **authenticated user's own ID** (not the org ID). The `self` field is an actor profile descriptor object used by the UI — not a plain user record.

List users (response includes users array plus org metadata)



## OpenAPI

````yaml /api-reference/specs/users.json get /api/users
openapi: 3.1.0
info:
  title: ConveYour API — Users
  description: Retrieve and manage users (admins, reps, and coaches) in your ConveYour org.
  version: 1.0.0
servers:
  - url: https://{subdomain}.conveyour.com
    description: Your organization's ConveYour instance
    variables:
      subdomain:
        default: acme
        description: >-
          Your organization's slug — the subdomain you sign in on. Replace
          `acme` with yours: if you sign in at `bigco.conveyour.com`, enter
          `bigco`.
security:
  - conveyourToken: []
tags:
  - name: Users
    description: >-
      Retrieve and manage users (admins, reps, and coaches) in your ConveYour
      org.
paths:
  /api/users:
    get:
      tags:
        - Users
      summary: List users
      description: >-
        Returns users for the org. The response object includes the user list
        under the `users` key along with metadata. The top-level `id` is the
        **authenticated user's own ID** (not the org ID). The `self` field is an
        actor profile descriptor object used by the UI — not a plain user
        record.


        List users (response includes users array plus org metadata)
      operationId: listUsersResponseIncludesUsersArrayPlusOrgMetadata
      parameters:
        - $ref: '#/components/parameters/teams'
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/Envelope'
                  - type: object
                    properties:
                      data:
                        $ref: '#/components/schemas/UsersIndex'
              example:
                status: ok
                message: success
                data:
                  id: CURRENT_USER_ID
                  is_admin: true
                  self:
                    ...: actor profile descriptor object
                  users:
                    - id: 64a1b2c3d4e5f6a7b8c9d0e1
                      email: admin@example.com
                      first_name: Admin
                      last_name: User
                      role: admin
                  sender_options: []
        '403':
          $ref: '#/components/responses/Forbidden'
components:
  parameters:
    teams:
      name: teams[]
      in: query
      description: >-
        Team scope for the request, as one or more team ObjectIds. The brackets
        are required: PHP keeps only the last value for a repeated plain key, so
        `teams=A&teams=B` silently resolves to B alone. On requests with a JSON
        body you may send `teams` (no brackets) in the body instead.


        **Values that are not valid ObjectIds are silently ignored** — a
        mistyped team ID behaves as if no team was sent. See the [teams section
        of the API conventions guide](/guides/api-conventions#team-scoping).
      style: form
      explode: true
      schema:
        type: array
        items:
          type: string
      example:
        - 64a1b2c3d4e5f6a7b8c9d0ff
  schemas:
    Envelope:
      type: object
      description: The common response envelope shared by all ConveYour endpoints.
      properties:
        status:
          type: string
          enum:
            - ok
            - failed
          description: '`ok` on success, `failed` on error.'
        message:
          type: string
          description: Human-readable description of the result.
        data:
          description: >-
            The response payload — an object or an array depending on the
            endpoint.
    UsersIndex:
      type: object
      description: >-
        The list endpoint returns a composite object describing the CALLER plus
        the org roster — not a bare array of users.
      properties:
        id:
          type: integer
          description: The calling user's ID.
        is_admin:
          type: boolean
          description: Whether the caller is an admin.
        self:
          type: object
          description: The caller's actor profile, from getActorProfile().
        users:
          type: array
          items:
            type: object
          description: The org roster, from getUsers().
        sender_options:
          type: array
          items:
            type: object
          description: Available sender options.
      required:
        - id
        - is_admin
        - self
        - users
        - sender_options
  responses:
    Forbidden:
      description: >-
        The token is missing or invalid, or the service account behind it lacks
        the permission this endpoint requires.
      content:
        application/json:
          example:
            status: failed
            message: Lacking necessary permission add_contacts
            data:
              permission: add_contacts
  securitySchemes:
    conveyourToken:
      type: apiKey
      in: header
      name: x-conveyour-token
      description: >-
        Your API key token. Contacts endpoints require a **Server-only — Full
        API** key — see [Authentication](/quickstart).

````

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