API Reference

List Custom Fields

get
https://{subdomain}.pinpointhq.com/api/v1/custom_fields
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
include
array of strings

Include related resources

fields[custom_fields]
array of objects

Include only specified fields of Custom Field in response

fields[custom_field_options]
array of objects

Include only specified fields of Custom Field Option in response

filter[template_custom_field_id]
array of integers

Filter records by Template custom field id

filter[template_custom_field_id]
filter[resource_type]
array of strings

Filter records with resource_type equal to this value

sort
array of strings

Sort records according to one or more criteria

You should not include both ascending id and descending -id fields the same time

integer
Defaults to 1

The page number of records to return

integer
0 to 1000
Defaults to 100

The number of records to return

string
enum

Include the total number of matched records within the meta key of the response object.

Allowed:
Responses

Updated 1 day ago

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/vnd.api+json

Updated 1 day ago