Skip to main content
GET
/
api
/
v1
/
custom-fields
Get Custom Fields
curl --request GET \
  --url https://app.journeybee.io/api/v1/custom-fields \
  --header 'Authorization: Bearer <token>'
[
  {
    "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"}
    ]
  }
]

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.

​
Authentication

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"

​
Query Parameters

​
category
string
Filter by category. Options: lead, lead_deal, partner
​
partner_type
string
Filter by partner type. Options: referral, reseller

​
Response Schema

​
custom_fields
array
Array of custom field definitions

​
Example Response

[
  {
    "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"}
    ]
  }
]

​
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