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

# Get a user

> Returns a single team user by ID, scoped to your org.

Get a user

**Permission:** the subject's own read check — an admin, or a user permitted to read that record. A caller who fails it gets `403 Permission Denied`.

**Response shape:** the actor profile plus two labelled blocks the list endpoint does not return — `permissions` (the user's effective permission keys) and `roles` (their assigned named roles). Each is `{label, value}`.

Unlike most endpoints in this API, a missing user genuinely returns **`404`** with `Unable to locate user.` — this handler passes the status explicitly.



## OpenAPI

````yaml /api-reference/specs/users.json get /api/users/{id}
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/{id}:
    get:
      tags:
        - Users
      summary: Get a user
      description: >-
        Returns a single team user by ID, scoped to your org.


        Get a user


        **Permission:** the subject's own read check — an admin, or a user
        permitted to read that record. A caller who fails it gets `403
        Permission Denied`.


        **Response shape:** the actor profile plus two labelled blocks the list
        endpoint does not return — `permissions` (the user's effective
        permission keys) and `roles` (their assigned named roles). Each is
        `{label, value}`.


        Unlike most endpoints in this API, a missing user genuinely returns
        **`404`** with `Unable to locate user.` — this handler passes the status
        explicitly.
      parameters:
        - name: id
          in: path
          required: true
          description: The id identifier.
          schema:
            type: string
      responses:
        '200':
          description: The user, with effective permissions and roles.
          content:
            application/json:
              example:
                status: ok
                message: User found
                data:
                  id: 42
                  name: Jane Doe
                  email: jane@example.com
                  permissions:
                    label: Permissions
                    value:
                      - contacts
                      - lessons
                  roles:
                    label: Roles
                    value: []
        '403':
          description: '`Permission Denied` — the caller may not read this user.'
        '404':
          description: '`Unable to locate user.`'
components:
  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.