LEleadfeeder
Custom Fields
v1

Retrieve Custom Fields

Changed on

Retrieve the list of all custom field definitions available in the account. The response includes each field's attributes.

Credit Note: Retrieving custom field definitions does not consume credits.

:::info Requires the custom_fields:read OAuth2 scope. :::

get/v1/custom-fields

Request

  • Base URL
    https://api.leadfeeder.com
  • URL
    https://api.leadfeeder.com/v1/custom-fields
  • Auth
    • API key in header X-Api-Key
    • or OAuth 2
      Authorization code: https://api.leadfeeder.com/v1/oauth/authorize
      Token URL: https://api.leadfeeder.com/v1/oauth/token scopes: custom_fields:read

Query parameters

account_idstring required

The Leadfeeder Account ID. The Account ID can be retrieved using the List Accounts endpoint.

page[num]integer

Page of results to fetch.

page[size]integer

The number of items per page. Maximum is 100.

filter[scope]'company' | 'contact'

Filter by entities that apply to either company or contact. If omitted, returns both kinds of entities.

filter[type]'text' | 'number' | 'boolean' | 'date' | 'contact_collection' | 'ai_score' | 'ai_text' | 'ai_number' | 'ai_boolean'

Filter by field type. If omitted, returns all field types.

Response

Success

Example response

{
  "data": [
    {
      "attributes": {
        "configuration": {
          "prompt_category": "technologies"
        },
        "created_at": "2024-12-10T15:57:25Z",
        "name": "Prospect",
        "scope": "company",
        "source": "user",
        "type": "text",
        "updated_at": "2024-11-24T11:50:00Z"
      },
      "id": "score",
      "relationships": {
        "created_by": {
          "id": "12345"
        }
      },
      "type": "custom_field"
    }
  ],
  "meta": {
    "pagination": {
      "page_count": 1,
      "page_num": 1,
      "total_count": 1
    },
    "request_id": "cf054205-dd8c-4473-8689-07c30fe0789f"
  }
}

Changes

  • ac752c6c2be0Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • 12ae8a6b9fadRevision changes
    • info

      the endpoint scheme security ApiKeyAuth was added to the API

    • info

      the endpoint scheme security OAuth2 was added to the API

    • info

      added the non-success response with the status