Retrieve Custom Fields - Leadfeeder API

Request

Authorization

API Key

Add parameter in header

X-Api-Key

Example:

X-Api-Key: ********************

or

Query Params

Request Code Samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --globoff 'https://api.leadfeeder.com/v1/custom-fields?account_id=123456&page[num]=1&page[size]=20&filter[scope]=company&filter[type]=text' \
--header 'X-Api-Key: <api-key>'

Responses

🟢200OK

application/json

Success

Bodyapplication/json

Example

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

🟠400Bad Request

🟠403Forbidden

🟠429Too Many Requests

🔴500Server Error

🔴504Gateway Timeout