SLslant
Custom Fields

Get a custom_field

Changed on

Retrieve a custom field by ID

get/v1/custom_fields/{id}

Request

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

Path parameters

idstring required

The custom_field ID

Response

successful

idstring required

The custom field ID

field_keystring required

The unique field key

display_namestring required

The human-readable field name

entity_type'Household' | 'Person' | 'Contact' | 'Opportunity' | 'Business' | 'Trust' | 'FinancialAccount' | 'InsurancePolicy' required

The entity type this field applies to

field_type'text' | 'number' | 'date' | 'boolean' | 'single_select' | 'user_reference' | 'cross_reference' | 'rich_text' | 'url' | 'multi_select' required

The field data type

company_idstring

The company ID

Example response

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

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