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

# List custom fields

> Returns a paginated list of custom fields scoped to the workspaces accessible by the API key. Each custom field has a stable `slug` (immutable) and a human-readable `name` (editable). Use the `slug` as the key when setting custom field values on contacts. Use the `workspaceIds` query parameter to narrow results to a subset of those workspaces.



## OpenAPI

````yaml https://api-public.skipcall.app/docs-json get /v1/custom-fields
openapi: 3.0.0
info:
  title: Skipcall Public API
  description: >-
    ## Overview

    The Skipcall Public API allows you to integrate Skipcall with your
    applications, CRM, or automation tools.


    ## Plan Requirements

    API access is available for **STARTER**, **INTERMÉDIAIRE** and **EXPERT**
    plans.


    ## Authentication

    All API requests require authentication using an API Key. Include your API
    key in the `Authorization` header:


    ```

    Authorization: Bearer sk_live_your_api_key_here

    ```


    You can generate API keys from your Skipcall dashboard under Settings > API
    Keys.


    ## Rate Limiting

    Rate limits vary by subscription plan:


    | Plan | Rate Limit |

    |------|------------|

    | STARTER | 100 requests/minute |

    | INTERMÉDIAIRE | 100 requests/minute |

    | EXPERT | 1000 requests/minute |


    Rate limit headers are included in every response:

    - `X-RateLimit-Limit`: Maximum requests per minute for your plan

    - `X-RateLimit-Remaining`: Remaining requests in the current window

    - `X-RateLimit-Reset`: Unix timestamp when the rate limit resets


    ## Errors

    The API uses standard HTTP status codes:

    - `200` - Success

    - `400` - Bad Request (invalid parameters)

    - `401` - Unauthorized (invalid or missing API key)

    - `403` - Forbidden (subscription required or plan not eligible)

    - `404` - Not Found

    - `429` - Too Many Requests (rate limit exceeded)

    - `500` - Internal Server Error


    ### Subscription Errors

    | Code | Description |

    |------|-------------|

    | `SUBSCRIPTION_REQUIRED` | An active subscription is required to access the
    API |

    | `PLAN_NOT_ELIGIBLE` | API access requires STARTER, INTERMÉDIAIRE or EXPERT
    plan |
  version: '1.0'
  contact: {}
servers:
  - url: https://api-public.skipcall.app
    description: Production
security: []
tags:
  - name: Contacts
    description: Manage your contacts
  - name: Calls
    description: Access call history and recordings
paths:
  /v1/custom-fields:
    get:
      tags:
        - Custom Fields
      summary: List custom fields
      description: >-
        Returns a paginated list of custom fields scoped to the workspaces
        accessible by the API key. Each custom field has a stable `slug`
        (immutable) and a human-readable `name` (editable). Use the `slug` as
        the key when setting custom field values on contacts. Use the
        `workspaceIds` query parameter to narrow results to a subset of those
        workspaces.
      operationId: CustomFieldController_list
      parameters:
        - name: workspaceIds
          required: false
          in: query
          description: >-
            Workspace IDs to narrow down results. Must be a subset of the
            workspaces accessible by the API key. Omit to return data from every
            workspace in scope. Accepts either a comma-separated string
            (`?workspaceIds=uuid1,uuid2`) — the documented format — or repeated
            array params (`?workspaceIds[]=uuid1&workspaceIds[]=uuid2`).
          schema:
            example: >-
              550e8400-e29b-41d4-a716-446655440000,6ba7b810-9dad-11d1-80b4-00c04fd430c8
            type: string
        - name: page
          required: false
          in: query
          description: Page number (1-indexed)
          schema:
            minimum: 1
            default: 1
            example: 1
            type: number
        - name: limit
          required: false
          in: query
          description: Number of items per page
          schema:
            minimum: 1
            maximum: 50
            default: 10
            example: 10
            type: number
        - name: search
          required: false
          in: query
          description: Search query to filter custom fields by name
          schema:
            maxLength: 100
            example: job
            type: string
      responses:
        '200':
          description: Paginated list of custom fields
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedPublicCustomFieldsDto'
        '401':
          description: Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        example: UNAUTHORIZED
                      message:
                        type: string
                        example: Invalid or revoked API key
                      status:
                        type: number
                        example: 401
        '403':
          description: One or more requested workspaceIds are outside the API key scope
      security:
        - ApiKey: []
components:
  schemas:
    PaginatedPublicCustomFieldsDto:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/PublicCustomFieldDto'
        total:
          type: number
          example: 100
        page:
          type: number
          example: 1
        limit:
          type: number
          example: 10
        totalPages:
          type: number
          example: 10
      required:
        - data
        - total
        - page
        - limit
        - totalPages
    PublicCustomFieldDto:
      type: object
      properties:
        id:
          type: string
          example: 550e8400-e29b-41d4-a716-446655440000
        name:
          type: string
          example: Job Title
          description: Human-readable label. Can be renamed without breaking integrations.
        slug:
          type: string
          example: job_title
          description: >-
            Stable, immutable identifier derived from the name at creation time.
            Use this as the key when setting custom field values on a contact
            via POST/PATCH /contacts.
        createdAt:
          format: date-time
          type: string
        updatedAt:
          format: date-time
          type: string
      required:
        - id
        - name
        - slug
        - createdAt
        - updatedAt
  securitySchemes:
    ApiKey:
      scheme: bearer
      bearerFormat: API Key
      type: http
      description: Enter your API Key (sk_live_xxx or sk_test_xxx)

````