API Reference

List Custom Attributes

get
https://{subdomain}.pinpointhq.com/api/v1/custom_attributes
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

See Custom Attributes to learn what Custom Attributes are.

Use Cases

To retrieve a complete list of Custom Attributes for an object (label and value), please use the List Custom Attributes endpoint:

  • Specify the custom_attributable_id and custom_attributable_type for the object whose Custom Attributes you wish to list.
  • Map custom_attribute.field_name for the label and custom_attribute.value for the value.
Query Params
include
array of strings

Include related resources

fields[custom_attributes]
array of objects

Include only specified fields of Custom Attribute in response

fields[custom_fields]
array of objects

Include only specified fields of Custom Field in response

fields[applications]
array of objects

Include only specified fields of Application in response

fields[candidates]
array of objects

Include only specified fields of Candidate in response

fields[jobs]
array of objects

Include only specified fields of Job in response

fields[job_seekers]
array of objects

Include only specified fields of Job Seeker in response

fields[job_templates]
array of objects

Include only specified fields of Job Template in response

fields[offers]
array of objects

Include only specified fields of Offer in response

fields[positions]
array of objects

Include only specified fields of Position in response

string

Filter records by Custom attributable id

filter[custom_attributable_type]
array of strings

Filter records by Custom attributable type

date-time

Filter records with created_at greater than this value

date-time

Filter records with created_at less than this value

date-time

Filter records with updated_at greater than this value

date-time

Filter records with updated_at less than 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 about 2 months 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 about 2 months ago