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

# Fetch Custom Fields

## `GET` Custom Fields

`GET` `/user-api/v1/custom-fields`

### Headers

| Header              | Value               |
| ------------------- | ------------------- |
| `x-rolodex-api-key` | `f1e2d3c4b5a697...` |

### Query Parameters

<ParamField path="limit" type="string">
  Set a limit to the number of records to return (Default:25)
</ParamField>

<ParamField path="offset" type="string">
  Number of records to skip.
</ParamField>

<ParamField path="order_by" type="string">
  Sort order: `created_at:asc`, `created_at:desc`, `name:asc`, `name:desc`
</ParamField>

<ParamField path="field_type" type="string">
  Filter by field type: `SINGLE_LINE_TEXT`, `USER, SINGLE_SELECT`, `MULTI_SELECT`, `DATE`, `NUMERIC`, `BOOLEAN`
</ParamField>

<ParamField path="entity_type" type="string">
  Filter by entity type: `CONTACT`, `COMPANY`

  ### Response
</ParamField>

```json theme={null}
{
  "pagination": {
    "limit": 25,
    "offset": 0,
    "total": 15
  },
  "data": [
    {
      "id": "field_12345",
      "name": "Lead Score",
      "field_type": "NUMERIC",
      "entity_type": "CONTACT",
      "created_at": "2025-01-15T10:30:00Z",
      "updated_at": "2025-01-15T10:30:00Z"
    },
    {
      "id": "field_67890",
      "name": "Company Size",
      "field_type": "SINGLE_SELECT",
      "entity_type": "COMPANY",
      "created_at": "2025-01-14T09:15:00Z",
      "updated_at": "2025-01-14T09:15:00Z",
      "multi_select_options": [
        {
          "id": "option_101",
          "value": "Startup (1-10)"
        },
        {
          "id": "option_102",
          "value": "Small (11-50)"
        },
        {
          "id": "option_103",
          "value": "Medium (51-200)"
        },
        {
          "id": "option_104",
          "value": "Large (200+)"
        }
      ]
    },
    {
      "id": "field_11111",
      "name": "Skills",
      "field_type": "MULTI_SELECT",
      "entity_type": "CONTACT",
      "created_at": "2025-01-13T08:00:00Z",
      "updated_at": "2025-01-13T08:00:00Z",
      "multi_select_options": [
        {
          "id": "option_201",
          "value": "JavaScript"
        },
        {
          "id": "option_202",
          "value": "Python"
        },
        {
          "id": "option_203",
          "value": "React"
        }
      ]
    },
    {
      "id": "field_22222",
      "name": "Department",
      "field_type": "SINGLE_LINE_TEXT",
      "entity_type": "CONTACT",
      "created_at": "2025-01-12T14:20:00Z",
      "updated_at": "2025-01-12T14:20:00Z"
    }
  ]
}
```

### With Entity Type Filter

`GET` `/user-api/v1/custom-fields?entity_type=CONTACT&limit=10`

### Response with entity type filter

```json theme={null}
{
  "pagination": {
    "limit": 10,
    "offset": 0,
    "total": 8
  },
  "data": [
    {
      "id": "field_12345",
      "name": "Lead Score",
      "field_type": "NUMERIC",
      "entity_type": "CONTACT",
      "created_at": "2025-01-15T10:30:00Z",
      "updated_at": "2025-01-15T10:30:00Z"
    },
    {
      "id": "field_11111",
      "name": "Skills",
      "field_type": "MULTI_SELECT",
      "entity_type": "CONTACT",
      "created_at": "2025-01-13T08:00:00Z",
      "updated_at": "2025-01-13T08:00:00Z",
      "multi_select_options": [
        {
          "id": "option_201",
          "value": "JavaScript"
        },
        {
          "id": "option_202",
          "value": "Python"
        },
        {
          "id": "option_203",
          "value": "React"
        }
      ]
    }
  ]
}
```

### With Combined Filters

`GET` `/user-api/v1/custom-fields?field_type=SINGLE_SELECT&entity_type=COMPANY&limit=10`

### Response with combined filters

```json theme={null}
{
  "pagination": {
    "limit": 10,
    "offset": 0,
    "total": 3
  },
  "data": [
    {
      "id": "field_67890",
      "name": "Company Size",
      "field_type": "SINGLE_SELECT",
      "entity_type": "COMPANY",
      "created_at": "2025-01-14T09:15:00Z",
      "updated_at": "2025-01-14T09:15:00Z",
      "multi_select_options": [
        {
          "id": "option_101",
          "value": "Large (200+)"
        },
        {
          "id": "option_102",
          "value": "Medium (51-200)"
        },
        {
          "id": "option_103",
          "value": "Small (11-50)"
        },
        {
          "id": "option_104",
          "value": "Startup (1-10)"
        }
      ]
    }
  ]
}
```

## `GET` a Custom Field

`GET` `/user-api/v1/custom-fields/:id`

### Path Parameters

<ParamField path="id" type="string">
  Custom Field ID
</ParamField>

### Endpoint Example

`GET` `/user-api/v1/custom-fields/field_12345`

### Response

```json theme={null}
{
  "data": {
    "id": "field_12345",
    "name": "Lead Score",
    "field_type": "NUMERIC",
    "entity_type": "CONTACT",
    "created_at": "2025-01-15T10:30:00Z",
    "updated_at": "2025-01-15T10:30:00Z"
  }
}
```

## Field Types

| **Type**           | **Description**               | **Example Usage**          |
| :----------------- | :---------------------------- | :------------------------- |
| `SINGLE_LINE_TEXT` | Single line text input        | Department, Job Title      |
| `USER`             | Reference to workspace user   | Account Manager, Sales Rep |
| `SINGLE_SELECT`    | Single choice from options    | Priority Level, Status     |
| `MULTI_SELECT`     | Multiple choices from options | Skills, Technologies       |
| `DATE`             | Date picker                   | Start Date, Follow-up Date |
| `NUMERIC`          | Number input                  | Lead Score, Revenue        |
| `BOOLEAN`          | True/false checkbox           | Is VIP, Active Status      |

## Entity Types

| **Type**  | **Description**                           |
| :-------- | :---------------------------------------- |
| `CONTACT` | Custom fields for contacts/people         |
| `COMPANY` | Custom fields for companies/organizations |