SLslant
Custom Fields

List custom_fields

Changed on

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

get/v1/custom_fields

Request

  • Base URL
    https://api.slant.app
  • URL
    https://api.slant.app/v1/custom_fields
  • Auth
    HTTP bearer

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' | 'Business' | 'Trust' | 'FinancialAccount' | 'InsurancePolicy'

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
  }
}

Changes

  • 173c41bf6be9Revision changes
    • warning

      added the new Business enum value to the // response property for the response status

    • warning

      added the new FinancialAccount enum value to the // response property for the response status

    • warning

      added the new InsurancePolicy enum value to the // response property for the response status

    • warning

      added the new Trust enum value to the // response property for the response status

    • warning

      added the new rich_text enum value to the // response property for the response status

    • warning

      added the new url enum value to the // response property for the response status

    • warning

      added the new user_reference enum value to the // response property for the response status

    • info

      added the new enum value Business to the query request parameter entity_type

    • info

      added the new enum value FinancialAccount to the query request parameter entity_type

    • info

      added the new enum value InsurancePolicy to the query request parameter entity_type

    • info

      added the new enum value Trust to the query request parameter entity_type

    • info

      added the media type application/json for the response with the status

    • info

      added the non-success 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

      removed the invalid_json enum value from the response property for the response status

    • info

      response property detail list-of-types was narrowed by removing types array from media type application/json of response 400