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

# List contact custom field definitions

> Find custom field IDs, types, and allowed values for contact imports and updates.

Use `customFieldDefinitionId` from the `items` array to identify a workspace field in a contact write. List definitions include their allowed options, and range definitions include their configured bounds.

Pass `nextOffset` as the `offset` for the next request. A `null` offset means there are no more results.

*Rate limit: 120 requests/minute per endpoint and workgroup. [Details](https://docs.jobin.cloud/development.md#rate-limits).*


## OpenAPI

````yaml openapi/jobin-integration.json GET /contacts/custom-field-definitions
openapi: 3.1.0
info:
  title: Jobin Integration API
  version: 1.0.0
  description: >-
    Work with Jobin contacts and outreach sequences from your recruiting tools
    and AI assistants. See [integration
    guidelines](https://docs.jobin.cloud/development#rate-limits) for rate
    limits and retries.
servers:
  - url: https://my.jobin.cloud/api/openapi/v1
    description: Public OpenAPI base URL. Append each path below to this base URL.
security: []
paths:
  /contacts/custom-field-definitions:
    get:
      summary: List contact custom field definitions
      description: >-
        Discover reusable workgroup field IDs, value types, and allowed values
        for contact writes.
      parameters:
        - name: limit
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 50
        - name: offset
          in: query
          schema:
            type: integer
            minimum: 0
            default: 0
      responses:
        '200':
          description: Definitions in the authenticated workspace
          content:
            application/json:
              schema:
                type: object
                required:
                  - items
                  - nextOffset
                properties:
                  items:
                    type: array
                    items:
                      type: object
                      required:
                        - customFieldDefinitionId
                        - fieldName
                        - valueType
                      properties:
                        customFieldDefinitionId:
                          type: string
                        fieldName:
                          type: string
                        valueType:
                          type: string
                          enum:
                            - freeText
                            - number
                            - date
                            - list
                            - range
                        options:
                          type: array
                          items:
                            type: object
                            properties:
                              label:
                                type: string
                              value:
                                type: string
                        rangeConfig:
                          type: object
                          properties:
                            min:
                              type: number
                            max:
                              type: number
                            step:
                              type: number
                            unit:
                              type: string
                  nextOffset:
                    type:
                      - integer
                      - 'null'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/RateLimitExceeded'
        '500':
          $ref: '#/components/responses/InternalServerError'
        default:
          $ref: '#/components/responses/ApiError'
      security:
        - ApiKeyAuth: []
components:
  responses:
    BadRequest:
      description: Invalid request or expected business-rule failure.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: >-
        Missing or invalid authentication, or missing required authentication
        context.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    RateLimitExceeded:
      description: >-
        Rate limit exceeded. Wait for the retry-after header before sending the
        next request.
      headers:
        retry-after:
          description: Seconds to wait before retrying.
          schema:
            type: integer
        x-ratelimit-limit:
          description: Maximum requests allowed in the current window.
          schema:
            type: integer
        x-ratelimit-remaining:
          description: Requests remaining in the current window.
          schema:
            type: integer
        x-ratelimit-reset:
          description: Seconds until the current window resets.
          schema:
            type: integer
      content:
        application/json:
          schema:
            oneOf:
              - $ref: '#/components/schemas/RateLimitError'
              - $ref: '#/components/schemas/Error'
    InternalServerError:
      description: Unexpected server failure. Internal details are masked.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    ApiError:
      description: Other client or server failure. Unknown errors expose a generic message.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    Error:
      type: object
      required:
        - code
        - error
      properties:
        code:
          type: string
          description: Stable error code. Input validation uses VALIDATION_ERROR.
        error:
          type: string
          description: >-
            User-facing message. Unknown failures return a generic message
            without internal details.
      example:
        code: UNHANDLED_EXCEPTION
        error: Unexpected error
    RateLimitError:
      type: object
      description: Returned when a public OpenAPI rate limit is exceeded.
      properties:
        statusCode:
          type: integer
          example: 429
        error:
          type: string
          example: Too Many Requests
        message:
          type: string
          description: Human-readable description of the limit that was exceeded.
        retryAfterSeconds:
          type: integer
          description: Seconds to wait before retrying the request.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Primary public authentication method. Create keys in Jobin.cloud under
        Workgroups > Integrations > Custom integration.

````

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