API Reference

List Onboarding Applications

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

The Onboarding Application represents an onboarding process related to a specific Application.

The Onboarding Application API exposes the status of the onboarding application and answers to onboarding questions.

Please see the includes query param to how to include onboarding question answers in the response.

Query Params
include
array of strings

Include related resources

fields[onboarding_applications]
array of objects

Include only specified fields of Onboarding Application in response

fields[applications]
array of objects

Include only specified fields of Application in response

fields[onboarding_answers]
array of objects

Include only specified fields of Onboarding Answer in response

string

Filter records by Application id

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 start_at greater than this value

date-time

Filter records with start_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