Platform API
Discovery
Discovery planners
Provides data for planners who started planning within a specified date range.
POST
https://api.flip.to/v1/company/data/discovery/planners
Query Parameters
startdate*
String
The inclusive date range in ISO 8601 format yyyy-MM-dd
(e.g. 2022-09-18)
enddate*
String
The inclusive date range in ISO 8601 format yyyy-MM-dd
(e.g. 2022-10-18)
page
String
The page number of the data to consume. If a page isn't specified, page should be set to 1.
pagesize
String
The total number of records to send for each page
Page size cannot exceed 500 records at a time, and if not specified, the default value would be set to 100.
Request Body
discoveries[]
String
An array of discovery IDs to limit results to. If no discoveries are specified, all discoveries the key has access to will be returned.
isIncludeReservations
Boolean
Indicates whether to include the plan's associated reservations.
isIncludeRestricted
Boolean
Indicates whether to include restricted (GDPR) data.
isIncludeGuests
Boolean
Indicate whethers to include guests planners.
isIncludeOptout
Boolean
Indicate whether to include planners who have chosen to opt-out.
Example
Discovery planners who opted-out
Provides data for planners who opted out within a specified date range.
POST
https://api.flip.to/v1/company/data/discovery/optouts
Query Parameters
startdate*
String
The inclusive date range in ISO 8601 format yyyy-MM-dd
(e.g. 2022-09-18)
enddate*
String
The inclusive date range in ISO 8601 format yyyy-MM-dd
(e.g. 2022-10-18)
page
String
The page number of the data to consume. If a page isn't specified, page should be set to 1.
pagesize
String
The total number of records to send for each page
Page size cannot exceed 500 records at a time, and if not specified, the default value would be set to 100.
Request Body
discoveries[]
String
An array of discovery IDs to limit results to. If no discoveries are specified, all discoveries the key has access to will be returned.
Example
Advocacy
Advocacy leads
Provides data for leads who signed up within a specified date range.
POST
https://api.flip.to/v1/company/data/advocacy/signups
Query Parameters
startdate*
String
The inclusive date range in ISO 8601 format yyyy-MM-dd
(e.g. 2022-09-18)
enddate*
String
The inclusive date range in ISO 8601 format yyyy-MM-dd
(e.g. 2022-10-18)
page
String
The page number of the data to consume. If a page isn't specified, page should be set to 1.
pagesize
String
The total number of records to send for each page
Page size cannot exceed 500 records at a time, and if not specified, the default value would be set to 100.
Request Body
properties[]
String
An array of property IDs to limit results to. If no properties are specified, all properties the key has access to will be returned.
isIncludeRestricted
Boolean
Indicates whether to include restricted (GDPR) data.
isIncludeOptout
Boolean
Indicate whether to include leads who have chosen to opt-out.
Example
Advocacy stories
Provides data for Advocacy stories that were submitted within a specified date range. Results limited to stories that include a photo submission.
POST
https://api.flip.to/v1/company/data/advocacy/stories
Query Parameters
startdate*
String
The inclusive date range in ISO 8601 format yyyy-MM-dd
(e.g. 2022-09-18)
enddate*
String
The inclusive date range in ISO 8601 format yyyy-MM-dd
(e.g. 2022-10-18)
page
String
The page number of the data to consume. If a page isn't specified, page should be set to 1.
pagesize
String
The total number of records to send for each page
Page size cannot exceed 500 records at a time, and if not specified, the default value would be set to 100.
Request Body
properties[]
String
An array of property IDs to limit results to. If no properties are specified, all properties the key has access to will be returned.
isIncludeRestricted
Boolean
Indicates whether to include restricted (GDPR) data.
isIncludeOptout
Boolean
Indicate whether to include leads who have chosen to opt-out.
Example
Advocacy leads who opted out
Provides data for leads who opted out within a specified date range.
POST
https://api.flip.to/v1/company/data/advocacy/optouts
Query Parameters
startdate*
String
The inclusive date range in ISO 8601 format yyyy-MM-dd
(e.g. 2022-09-18)
enddate*
String
The inclusive date range in ISO 8601 format yyyy-MM-dd
(e.g. 2022-10-18)
page
String
The page number of the data to consume. If a page isn't specified, page should be set to 1.
pagesize
String
The total number of records to send for each page
Page size cannot exceed 500 records at a time, and if not specified, the default value would be set to 100.
Request Body
properties[]
String
An array of property IDs to limit results to. If no properties are specified, all properties the key has access to will be returned.
Example
Last updated