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

# List client contacts

> Retrieve a paginated list of client contacts, including the linked person, client company, and status in each row.

**Filters**: `person_id`, `client_id` (company UUID), `client_contact_status_id`.

**Sorting**: `sort_by` (`created_at` or `updated_at`) with `sort_order` (`asc` or `desc`, default `desc`).

**Pagination**: Use `offset` and `limit` query params (max 100 per page).

Deleted client contacts are omitted.



## OpenAPI

````yaml /api-reference/openapi-v1.json get /v1/client-contacts
openapi: 3.1.0
info:
  title: Stardex API (v1)
  version: 1.0.0
  description: >-
    Stardex ATS API — manage candidates, jobs, companies, and recruiting
    workflows.
servers:
  - url: https://api.stardex.ai
    description: Production API server
security:
  - bearerAuth: []
tags:
  - name: Persons
    description: Manage person records — contacts, work history, and custom fields.
  - name: Jobs
    description: Manage job postings — pipeline stages, team members, and custom fields.
  - name: Candidates
    description: Manage candidate records and pipeline stage transitions.
  - name: Companies
    description: Browse and retrieve company records.
  - name: Lists
    description: Create, search, and retrieve saved person and company lists.
  - name: Person Activities
    description: Create and manage activity records (notes, emails, meetings) for persons.
  - name: Team Members
    description: List team members for use in search filters and assignments.
  - name: Custom Fields
    description: Retrieve custom field definitions and tag options for search filters.
paths:
  /v1/client-contacts:
    get:
      tags:
        - Client Contacts
      summary: List client contacts
      description: >-
        Retrieve a paginated list of client contacts, including the linked
        person, client company, and status in each row.


        **Filters**: `person_id`, `client_id` (company UUID),
        `client_contact_status_id`.


        **Sorting**: `sort_by` (`created_at` or `updated_at`) with `sort_order`
        (`asc` or `desc`, default `desc`).


        **Pagination**: Use `offset` and `limit` query params (max 100 per
        page).


        Deleted client contacts are omitted.
      operationId: listClientContacts
      parameters:
        - schema:
            type:
              - integer
              - 'null'
            minimum: 0
            default: 0
            description: Records to skip for pagination. Defaults to 0.
          required: false
          name: offset
          in: query
        - schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 100
            description: Max records per page (1–100). Defaults to 100.
          required: false
          name: limit
          in: query
        - schema:
            type: string
            format: uuid
            description: Return only the client contact linked to this person UUID.
          required: false
          name: person_id
          in: query
        - schema:
            type: string
            format: uuid
            description: Return only client contacts linked to this client company UUID.
          required: false
          name: client_id
          in: query
        - schema:
            type: string
            format: uuid
            description: >-
              Return only client contacts with this status UUID. Use GET
              /v1/client-contacts/statuses to discover status IDs.
          required: false
          name: client_contact_status_id
          in: query
        - schema:
            type: string
            enum:
              - created_at
              - updated_at
            default: created_at
            description: |-
              Column to sort results by. Defaults to `created_at`.
              - `created_at` — when the client contact was created
              - `updated_at` — when the client contact was last updated
          required: false
          name: sort_by
          in: query
        - schema:
            type: string
            enum:
              - asc
              - desc
            default: desc
            description: Sort direction. Defaults to `desc` (newest first).
          required: false
          name: sort_order
          in: query
      responses:
        '200':
          description: Client contacts fetched
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientContactsListResponse'
              example:
                success: true
                data:
                  - id: ab12cd34-ef56-7890-ab12-cd34ef567890
                    person_id: fff66666-0000-1111-2222-333333336666
                    client_id: bbb22222-cccc-dddd-eeee-ffffffff2222
                    client_contact_status_id: 890e1234-f56a-78b9-c012-345678901234
                    person:
                      id: fff66666-0000-1111-2222-333333336666
                      name: Jordan Lee
                      first_name: Jordan
                      last_name: Lee
                      current_job_title: Head of Talent
                      image_url: https://example.com/jordan-lee.png
                    company:
                      id: bbb22222-cccc-dddd-eeee-ffffffff2222
                      name: Acme Corp
                      domain: acme.example.com
                    status:
                      id: 890e1234-f56a-78b9-c012-345678901234
                      name: Active
                      color: '#3b82f6'
                      stage_order: 1
                      is_default_status: true
                    owner_ids:
                      - ddd44444-eeee-ffff-0000-111111114444
                    created_at: '2024-01-15T10:00:00Z'
                    updated_at: '2024-02-01T09:30:00Z'
                meta:
                  total: 42
                  offset: 0
                  limit: 100
        '400':
          description: Validation error
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                    description: Always false for error responses.
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        description: >-
                          Machine-readable error code (e.g. "VALIDATION_ERROR",
                          "NOT_FOUND").
                      message:
                        type: string
                        description: Human-readable error description.
                    required:
                      - code
                      - message
                required:
                  - success
                  - error
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                    description: Always false for error responses.
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        description: >-
                          Machine-readable error code (e.g. "VALIDATION_ERROR",
                          "NOT_FOUND").
                      message:
                        type: string
                        description: Human-readable error description.
                    required:
                      - code
                      - message
                required:
                  - success
                  - error
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                    description: Always false for error responses.
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        description: >-
                          Machine-readable error code (e.g. "VALIDATION_ERROR",
                          "NOT_FOUND").
                      message:
                        type: string
                        description: Human-readable error description.
                    required:
                      - code
                      - message
                required:
                  - success
                  - error
components:
  schemas:
    ClientContactsListResponse:
      type: object
      properties:
        success:
          type: boolean
          enum:
            - true
        data:
          type: array
          items:
            $ref: '#/components/schemas/ClientContact'
        meta:
          type: object
          properties:
            total:
              type: number
              description: Total matching records across all pages.
            offset:
              type: number
              description: Current pagination offset.
            limit:
              type: number
              description: Page size used for this request.
          required:
            - total
            - offset
            - limit
      required:
        - success
        - data
        - meta
    ClientContact:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Client contact UUID.
        person_id:
          type:
            - string
            - 'null'
          format: uuid
          description: Person UUID linked to this client contact.
        client_id:
          type:
            - string
            - 'null'
          format: uuid
          description: Client company UUID this contact belongs to.
        client_contact_status_id:
          type:
            - string
            - 'null'
          format: uuid
          description: Assigned client contact status UUID, if any.
        person:
          allOf:
            - $ref: '#/components/schemas/ClientContactPerson'
            - type:
                - object
                - 'null'
              description: Linked person summary. Null when the person record is missing.
        company:
          allOf:
            - $ref: '#/components/schemas/ClientContactCompany'
            - type:
                - object
                - 'null'
              description: Linked client company summary. Null when no company is linked.
        status:
          allOf:
            - $ref: '#/components/schemas/ClientContactStatusItem'
            - type:
                - object
                - 'null'
              description: Assigned status details. Null when the contact has no status.
        owner_ids:
          type: array
          items:
            type: string
            format: uuid
          description: Team member UUIDs assigned as owners.
        created_at:
          type: string
          description: ISO 8601 creation timestamp.
        updated_at:
          type: string
          description: ISO 8601 last-updated timestamp.
      required:
        - id
        - person_id
        - client_id
        - client_contact_status_id
        - person
        - company
        - status
        - owner_ids
        - created_at
        - updated_at
    ClientContactPerson:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Person UUID.
        name:
          type:
            - string
            - 'null'
          description: Full name.
        first_name:
          type:
            - string
            - 'null'
          description: First name.
        last_name:
          type:
            - string
            - 'null'
          description: Last name.
        current_job_title:
          type:
            - string
            - 'null'
          description: Current job title.
        image_url:
          type:
            - string
            - 'null'
          description: Profile image URL.
      required:
        - id
        - name
        - first_name
        - last_name
        - current_job_title
        - image_url
    ClientContactCompany:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Client company UUID. Same as `client_id`.
        name:
          type: string
          description: Company display name.
        domain:
          type:
            - string
            - 'null'
          description: Company domain, if known.
      required:
        - id
        - name
        - domain
    ClientContactStatusItem:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Client contact status UUID.
        name:
          type: string
          description: Status label for client contacts (e.g. "Active", "Churned").
        color:
          type:
            - string
            - 'null'
          description: Hex color code.
        stage_order:
          type:
            - number
            - 'null'
          description: Display order within the contact status pipeline.
        is_default_status:
          type: boolean
          description: Whether this is the default status for new client contacts.
      required:
        - id
        - name
        - color
        - stage_order
        - is_default_status
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Authenticate with a Bearer token: API key, OAuth token, or session
        token.

````

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