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

# List users

> Returns a paginated list of users in your organization.



## OpenAPI

````yaml GET /api/v1/users
openapi: 3.0.0
info:
  description: REST API for AccessOwl third-party integrations
  title: AccessOwl API
  version: 1.0.0
servers:
  - url: https://api.accessowl.com
    variables: {}
security:
  - bearer: []
tags: []
paths:
  /api/v1/users:
    get:
      tags:
        - users
      summary: List users
      description: Returns a paginated list of users in your organization.
      operationId: AccessOwlApi.StaffController.index
      parameters:
        - description: 'Maximum results to return (default: 20, max: 100)'
          in: query
          name: limit
          required: false
          schema:
            type: integer
        - description: >-
            Opaque cursor returned in the previous response's
            `meta.next_cursor`. Omit for the first page.
          in: query
          name: cursor
          required: false
          schema:
            type: string
        - description: Filter users by status. Returns active users by default
          in: query
          name: status
          required: false
          schema:
            enum:
              - onboarding_provisioning_planned
              - onboarding
              - active
              - inactive
              - offboarding_planned
              - offboarding
              - offboarded
              - all
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserList'
          description: User list
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Unauthorized
      callbacks: {}
components:
  schemas:
    UserList:
      description: Paginated list of users
      properties:
        data:
          description: List of users
          items:
            $ref: '#/components/schemas/User'
          type: array
        meta:
          $ref: '#/components/schemas/PaginationMeta'
      required:
        - data
        - meta
      title: UserList
      type: object
    Error:
      description: Standard error response
      example:
        error: not_found
        message: Resource not found
      properties:
        error:
          description: Error code
          example: not_found
          type: string
        errors:
          additionalProperties:
            items:
              type: string
            type: array
          description: Field-specific validation errors (only for 422 responses)
          example:
            email:
              - has invalid format
            first_name:
              - can't be blank
          type: object
        message:
          description: Human-readable error message
          example: Resource not found
          type: string
      required:
        - error
        - message
      title: Error
      type: object
    User:
      description: A user in the organization
      example:
        deactivated_at: null
        departments:
          - Engineering
        email: john@example.com
        employment_type: full_time
        first_name: John
        full_name: John Doe
        id: 7488a646-e31f-11e4-aace-600308960662
        inserted_at: '2023-01-01T00:00:00Z'
        job_title: Software Engineer
        last_name: Doe
        location_city: San Francisco
        manager_user_id: null
        status: active
        teams:
          - Engineering
          - Backend
        updated_at: '2023-01-01T00:00:00Z'
      properties:
        deactivated_at:
          description: Deactivation timestamp
          format: date-time
          nullable: true
          type: string
        departments:
          description: Departments the user belongs to
          items:
            type: string
          type: array
        email:
          description: Email address
          format: email
          type: string
        employment_type:
          description: Employment type
          enum:
            - full_time
            - part_time
            - contract
            - freelance
            - internship
            - apprenticeship
            - working_student
            - training
          nullable: true
          type: string
        first_name:
          description: First name
          type: string
        full_name:
          description: Full name (computed)
          type: string
        id:
          description: User ID
          format: uuid
          type: string
        inserted_at:
          description: Creation timestamp
          format: date-time
          type: string
        job_title:
          description: Job title
          nullable: true
          type: string
        last_name:
          description: Last name
          type: string
        location_city:
          description: City location
          nullable: true
          type: string
        manager_user_id:
          description: Manager user ID
          format: uuid
          nullable: true
          type: string
        status:
          description: Current status
          enum:
            - active
            - inactive
            - onboarding
            - onboarding_provisioning_planned
            - offboarding
            - offboarding_planned
            - offboarded
          type: string
        teams:
          description: Teams the user belongs to
          items:
            type: string
          type: array
        updated_at:
          description: Last update timestamp
          format: date-time
          type: string
      required:
        - id
        - first_name
        - last_name
        - email
        - status
      title: User
      type: object
    PaginationMeta:
      description: Pagination metadata
      example:
        page: 1
        page_size: 20
        total_count: 100
        total_pages: 5
      properties:
        page:
          description: Current page number
          type: integer
        page_size:
          description: Items per page
          type: integer
        total_count:
          description: Total number of items
          type: integer
        total_pages:
          description: Total number of pages
          type: integer
      required:
        - page
        - page_size
        - total_count
        - total_pages
      title: PaginationMeta
      type: object
  securitySchemes:
    bearer:
      description: >-
        Bearer token authentication. Pass your AccessOwl API token in the
        `Authorization` header as `Bearer <token>`.
      scheme: bearer
      type: http

````