# List custom fields

Endpoint: GET /api/internal/custom-fields/
Version: 2.0
Security: ApiKeyAuth

## Security:

  - `ApiKeyAuth` (unknown)
    apiKey in header Authorization

## Query parameters:

  - `limit` (integer)
    Number of results to return per page.

  - `offset` (integer)
    The initial index from which to return the results.

  - `ordering` (string)
    Which field to use when ordering the results.

  - `search` (string)
    A search term.

  - `is_active` (boolean)
    Filter by active status (true/false)

  - `group_id` (integer)
    Filter by group ID (integer)

  - `entity_type` (string)
    Filter by entity type

## Response 200 fields (application/json):

  - `count` (integer, required)
    Example: 123

  - `next` (string)
    Example: http://api.example.org/accounts/?offset=400&limit=100

  - `previous` (string)
    Example: http://api.example.org/accounts/?offset=200&limit=100

  - `results` (array, required)

  - `results.id` (integer)

  - `results.entity_type` (string, required)
    Enum: "property", "owner"

  - `results.group` (object)

  - `results.group.id` (integer)

  - `results.group.label` (string, required)

  - `results.uuid` (string)

  - `results.label` (string, required)

  - `results.field_type` (string, required)
    Enum: "text", "text_input", "url", "boolean", "number", "phone", "money", "date", "select", "multiselect"

  - `results.required` (boolean)

  - `results.position` (integer)

  - `results.is_active` (boolean)

  - `results.options` (array)

  - `results.options.id` (integer)

  - `results.options.label` (string, required)

  - `results.options.is_active` (boolean)

  - `results.options.created` (string)

  - `results.options.updated` (string)

  - `results.options.position` (integer)

  - `results.options.uuid` (string)

  - `results.options.field_id` (integer)

  - `results.created` (string)

  - `results.updated` (string)

  - `results.account_id` (integer)

  - `results.machine_name` (string)
    Machine-friendly key for integrations, e.g., 'custom_field'

  - `results.placeholder` (string)
    Optional placeholder text for the custom_field

## Response 400:

  - `400` (unknown)
    Bad request: the body or parameters failed validation. The body names each invalid field.

## Response 401:

  - `401` (unknown)
    Missing or invalid API key. Send `Authorization: Api-Key YOUR_OPEN_API_KEY`.

## Response 401 fields (application/json):

  - `detail` (string, required)

## Response 403:

  - `403` (unknown)
    The key is valid, but its user lacks permission, or the plan does not include this capability.

## Response 403 fields (application/json):

  - `detail` (string, required)

## Response 429:

  - `429` (unknown)
    Rate limit exceeded (120 requests/minute and 5,000 requests/hour per account, per service). Wait the number of seconds in the message, then retry.

## Response 429 fields (application/json):

  - `detail` (string, required)

## Response 429 headers (application/json):

  - `Retry-After` (integer)
    Seconds to wait before retrying, when the server can tell.

## Response 500:

  - `500` (unknown)
    Unexpected server error. Retry with exponential backoff; report it if it persists. The body may be HTML rather than JSON.

