v1

latestOpenAPI 3.0.12026-07-268028223.9 KB

Custom Fields

List custom_fields

List all custom fields. book_id is accepted for backwards compatibility but ignored.

get/v1/custom_fields

Query parameters

pageinteger

Page number

per_pageinteger

Items per page (1-100, default: 25). Values over 100 will be clamped to 100.

book_idstring

Deprecated. Ignored.

entity_type'Household' | 'Person' | 'Contact' | 'Opportunity'

Filter by entity type

Response

successful

Example response

{
  "data": [
    {
      "id": "abc123xyz",
      "field_key": "pageport_lead_source",
      "display_name": "Lead Source",
      "entity_type": "Household",
      "field_type": "text",
      "options": {
        "select_options": [
          "Option 1",
          "Option 2"
        ],
        "cross_reference_allowed_target_types": [
          "Household",
          "Contact"
        ]
      }
    }
  ],
  "pagination": {
    "current_page": 1,
    "total_pages": 10,
    "total_count": 100,
    "per_page": 25
  }
}