List custom fields
Your workspace's custom contact fields and their keys.
GET
/api/v1/contact-fieldsScope
contacts:readReturns every custom field, in the order the dashboard shows them. Use each field's key in a contact's customFields.
Example request
curl "https://api.pedibee.com/api/v1/contact-fields" \
-H "Authorization: Bearer $PEDIBEE_API_KEY"Response
{
"data": [
{
"id": "66f1c2a9e4b0a1b2c3d4e201",
"key": "plan",
"label": "Plan",
"type": "SELECT",
"options": [
"Free",
"Pro",
"Enterprise"
],
"position": 0,
"createdAt": "2026-10-05T09:30:00.000Z",
"updatedAt": "2026-10-05T09:30:00.000Z"
},
{
"id": "66f1c2a9e4b0a1b2c3d4e202",
"key": "seats",
"label": "Seats",
"type": "NUMBER",
"options": [],
"position": 1,
"createdAt": "2026-10-05T09:30:00.000Z",
"updatedAt": "2026-10-05T09:30:00.000Z"
}
]
}Not paged: a workspace has at most 50 fields.
Errors
Every error is { "error": "…" } with a message you can show. See Errors and limits.
| Status | When |
|---|---|
403 | The key doesn’t have contacts:read, or its creator’s role no longer allows it. |
401 | The API key is missing, invalid, revoked or expired. |
429 | Too many requests. Wait for the seconds in Retry-After. |