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

# Get Custom Fields

> Retrieve all custom fields for a company with filtering by category and partner type

## Authentication

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET "https://app.journeybee.io/api/v1/custom-fields?category=lead" \
    -H "Authorization: Bearer your-api-key-uuid" \
    -H "Content-Type: application/json"
  ```
</CodeGroup>

## Query Parameters

<ParamField query="category" type="string">
  Filter by category. Options: `lead`, `lead_deal`, `partner`
</ParamField>

<ParamField query="partner_type" type="string">
  Filter by partner type. Options: `referral`, `reseller`
</ParamField>

## Response Schema

<ResponseField name="custom_fields" type="array">
  Array of custom field definitions

  <Expandable title="Custom Field Object">
    <ResponseField name="id" type="number">Custom field ID</ResponseField>
    <ResponseField name="uuid" type="string">Custom field UUID</ResponseField>
    <ResponseField name="label" type="string">Field label</ResponseField>
    <ResponseField name="type" type="string">Field type: `text`, `textarea`, `number`, `date`, `boolean`, `select`, `multi_select`</ResponseField>
    <ResponseField name="category" type="string">Field category: `lead`, `lead_deal`, `partner`</ResponseField>
    <ResponseField name="partner_type" type="string">Partner type association</ResponseField>
    <ResponseField name="required" type="boolean">Whether field is required</ResponseField>
    <ResponseField name="shared" type="boolean">Whether field is shared with partners</ResponseField>
    <ResponseField name="options" type="array">Array of options for select/multi-select fields</ResponseField>
  </Expandable>
</ResponseField>

## Example Response

<ResponseExample>
  ```json 200 OK theme={null}
  [
    {
      "id": 5,
      "uuid": "cf-uuid-123",
      "label": "Revenue Potential",
      "type": "number",
      "category": "lead",
      "partner_type": "referral",
      "required": false,
      "shared": true,
      "options": null
    },
    {
      "id": 6,
      "label": "Priority Level",
      "type": "select",
      "category": "lead",
      "options": [
        {"id": 1, "label": "High"},
        {"id": 2, "label": "Medium"},
        {"id": 3, "label": "Low"}
      ]
    }
  ]
  ```
</ResponseExample>

## Notes

* Requires API key with `read_access` permission
* Custom fields define the schema for lead, deal, and partner data
* Shared fields are synchronized with partner companies