> ## 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 fee statuses

> Returns every fee status of the workspace (the statuses of retainers, milestones, placements and retainer packs), ordered by position. No pagination: the full list is always returned.

**When to use**: get a `fee_status_id` for `POST /v1/retainer-packs` or `PATCH /v1/retainer-packs/{id}`.

**Access**: Everyone in the workspace. API keys need the `fees:read` scope.



## OpenAPI

````yaml /api-reference/openapi-v1.json get /v1/fee-statuses
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.
  - name: Campaigns
    description: >-
      Create and edit email campaigns, enroll people through enrollment batches,
      and manage who is enrolled.
paths:
  /v1/fee-statuses:
    get:
      tags:
        - Retainer Packs
      summary: List fee statuses
      description: >-
        Returns every fee status of the workspace (the statuses of retainers,
        milestones, placements and retainer packs), ordered by position. No
        pagination: the full list is always returned.


        **When to use**: get a `fee_status_id` for `POST /v1/retainer-packs` or
        `PATCH /v1/retainer-packs/{id}`.


        **Access**: Everyone in the workspace. API keys need the `fees:read`
        scope.
      operationId: listFeeStatuses
      responses:
        '200':
          description: Fee statuses fetched
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FeeStatusesListResponse'
              example:
                success: true
                data:
                  - id: 4d5e6f7a-8b9c-4d0e-9f2a-3b4c5d6e7f8b
                    name: Pending
                    status_type: pending
                    color: '#f59e0b'
                    position: 0
                    is_default: true
                  - id: 5e6f7a8b-9c0d-4e1f-8a3b-4c5d6e7f8a9c
                    name: Invoiced
                    status_type: invoiced
                    color: '#3b82f6'
                    position: 1
                    is_default: false
                  - id: 5e6f7a8b-9c0d-4e1f-8a3b-4c5d6e7f8a9b
                    name: Paid
                    status_type: paid
                    color: '#22c55e'
                    position: 2
                    is_default: false
                  - id: 6f7a8b9c-0d1e-4f2a-9b4c-5d6e7f8a9b0d
                    name: Cancelled
                    status_type: cancelled
                    color: '#6b7280'
                    position: 3
                    is_default: false
        '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.
                      details:
                        type: object
                        additionalProperties: {}
                        description: >-
                          Extra facts about the error when they help you fix it,
                          such as a limit and when it resets.
                    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.
                      details:
                        type: object
                        additionalProperties: {}
                        description: >-
                          Extra facts about the error when they help you fix it,
                          such as a limit and when it resets.
                    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.
                      details:
                        type: object
                        additionalProperties: {}
                        description: >-
                          Extra facts about the error when they help you fix it,
                          such as a limit and when it resets.
                    required:
                      - code
                      - message
                required:
                  - success
                  - error
components:
  schemas:
    FeeStatusesListResponse:
      type: object
      properties:
        success:
          type: boolean
          enum:
            - true
        data:
          type: array
          items:
            $ref: '#/components/schemas/FeeStatus'
      required:
        - success
        - data
    FeeStatus:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Fee status UUID.
        name:
          type: string
          description: Status name shown in the app (e.g. "Invoiced").
        status_type:
          type: string
          enum:
            - pending
            - invoiced
            - paid
            - cancelled
          description: >-
            Lifecycle category of the status: `pending`, `invoiced`, `paid` or
            `cancelled`. Revenue reports count `paid` fees as collected.
        color:
          type: string
          description: Hex color code of the status badge.
        position:
          type: number
          description: Display order of the status, lowest first.
        is_default:
          type: boolean
          description: >-
            Whether new retainers, milestones and placements start in this
            status.
      required:
        - id
        - name
        - status_type
        - color
        - position
        - is_default
  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.