Custom Fields

Fetch Custom Field

get/api/v1/custom_fields/{id}

Request

  • Base URL
    https://your-subdomain.pinpointhq.com
  • URL
    https://your-subdomain.pinpointhq.com/api/v1/custom_fields/{id}
  • Auth
    API key in header X-API-KEY

Query parameters

includestring[]

Custom Field relationships available for inclusion

Include related resources

fields[custom_fields]CustomFieldsReadableAttribute[]

Custom Field readable attributes list

Include only specified fields of Custom Field in response

fields[custom_field_options]CustomFieldOptionsReadableAttribute[]

Custom Field Option readable attributes list

Include only specified fields of Custom Field Option in response

Response

OK: Custom Field resource

Changes

No recorded changes to this operation across all 1 revision of this API.