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

# List users

> Returns all non-archived users for the API key's company.




## OpenAPI

````yaml /openapi.yaml get /api/users
openapi: 3.0.3
info:
  title: Aptly API
  version: '1.1'
  description: |
    The Aptly API lets external systems work with boards, contacts, inboxes,
    tasks, files, and other Aptly resources.

    Most endpoints accept an API key in the `x-token` header. Some endpoints
    also accept a delegate token or partner bearer token, as shown in each
    operation's security requirements, and explicitly public endpoints require
    no credential. API keys are scoped to a company and may be restricted to
    specific boards and read, insert, or update permissions; requests outside
    those restrictions receive a 403 `FORBIDDEN` response.
servers:
  - url: https://core-api.getaptly.com
    description: Production
security:
  - ApiKeyHeader: []
paths:
  /api/users:
    get:
      tags:
        - Users
      summary: List users
      description: |
        Returns all non-archived users for the API key's company.
      operationId: listUsers
      responses:
        '200':
          description: List of users.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        _id:
                          type: string
                          description: User ID.
                        name:
                          type: string
                          description: Full name (firstname + lastname).
                        role:
                          type: string
                          nullable: true
                          description: Role name, or null if the role has been deleted.
              example:
                data:
                  - _id: abc123
                    name: Alice Smith
                    role: Admin
                  - _id: def456
                    name: Bob Jones
                    role: Staff
        '401':
          description: Invalid or missing API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - ApiKeyHeader: []
components:
  schemas:
    Error:
      type: object
      properties:
        error:
          type: string
        message:
          type: string
  securitySchemes:
    ApiKeyHeader:
      type: apiKey
      in: header
      name: x-token

````

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