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

# Get Clients

> Returns a paginated list of all clients for your company.

<Info>
  Results are paginated. Use the `items_per_page` parameter (1–100) and `page` parameter to navigate. The response includes a `total_count` field indicating the total number of clients.
</Info>


## OpenAPI

````yaml api-reference/v01.12.00/openapi-v01.12.00.json GET /clients
openapi: 3.0.0
info:
  title: Roosted
  version: 0.1.12
  contact:
    name: Support
    url: https://support.roostedhr.com/support/home
    email: support@roostedhr.com
  description: |-
    Enterprise API

    Sandbox keys and Production keys are requested from support
servers:
  - url: https://api.roostedhr.com/api/1_12
  - url: https://sandbox.roostedhr.com/api/1_12
security:
  - X-API-KEY: []
tags:
  - name: Announcements
  - name: Areas
  - name: Clients
  - name: Company
  - name: Configuration
  - name: Events
  - name: Locations
  - name: Payroll Groups
  - name: Rate Cards
  - name: Shifts
  - name: Skillsets
  - name: Time Tracking
  - name: Wage Rules
  - name: Workers
paths:
  /clients:
    get:
      tags:
        - Clients
      summary: Get Clients
      description: Returns a paginated list of all clients for your company.
      operationId: get-clients
      parameters:
        - schema:
            type: number
            minimum: 1
            maximum: 100
          in: query
          name: items_per_page
          description: Number of clients per page (1–100).
        - schema:
            type: number
            minimum: 1
          in: query
          name: page
          description: Page number (starts at 1).
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  clients:
                    type: array
                    items:
                      $ref: '#/components/schemas/Client'
                  total_count:
                    type: number
                    description: Total number of clients.
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: string
                    description: Machine-readable error code.
                  error:
                    type: string
                    description: Human-readable error message.
              examples:
                Invalid page:
                  value:
                    code: CLI-1100
                    error: Invalid page parameter
                Invalid items_per_page:
                  value:
                    code: CLI-1200
                    error: Invalid items_per_page parameter
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: string
                    description: Machine-readable error code.
                  error:
                    type: string
                    description: Human-readable error message.
              examples:
                Invalid API key:
                  value:
                    code: ATH-100
                    error: Invalid or missing API key
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: string
                    description: Machine-readable error code.
                  error:
                    type: string
                    description: Human-readable error message.
              examples:
                Not found:
                  value:
                    code: CLI-300
                    error: Client not found
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: string
                    description: Machine-readable error code.
                  error:
                    type: string
                    description: Human-readable error message.
              examples:
                Unexpected error:
                  value:
                    code: CLI-2000
                    error: An unexpected error occurred
components:
  schemas:
    Client:
      title: Client
      type: object
      properties:
        id:
          type: string
          description: Unique client identifier.
          example: uLu8K
        client_name:
          type: string
          description: Client display name.
          example: Acme Corp
        client_contact_name:
          type: string
          nullable: true
          description: Primary contact name.
        client_contact_phone:
          type: string
          nullable: true
          description: Primary contact phone number.
        client_contact_email:
          type: string
          nullable: true
          description: Primary contact email address.
        client_contact_title:
          type: string
          nullable: true
          description: Primary contact job title.
        default_comments_for_workers:
          type: string
          nullable: true
          description: >-
            Default instructions shown to workers assigned to this client's
            events.
        client_invoice_customer_id:
          type: string
          nullable: true
          description: External invoice/customer ID for billing integration.
        client_address:
          type: string
          nullable: true
          description: Street address.
        client_city:
          type: string
          nullable: true
          description: City.
        client_state:
          type: string
          nullable: true
          description: State or province.
        client_postal_code:
          type: string
          nullable: true
          description: Postal or ZIP code.
        company_name:
          type: string
          nullable: true
          description: Company name associated with the client.
        client_portal_connection_status:
          type: integer
          nullable: true
          description: >-
            Client portal connection status. `0` = invited, `2` = connected,
            `null` = not connected.
        client_portal_connection_datetime:
          type: string
          nullable: true
          description: Datetime when the client portal was connected.
        client_portal_invite_datetime:
          type: string
          nullable: true
          description: Datetime when the client portal invitation was sent.
        client_portal_invite_email:
          type: string
          nullable: true
          description: Email address the client portal invitation was sent to.
        pending:
          type: boolean
          description: Whether the client is in a pending state.
  securitySchemes:
    X-API-KEY:
      name: X-API-KEY
      type: apiKey
      in: header

````