GET
/
api
/
v3
/
touches

​
Parameters

​
page
integer

The page number of the results you want to retrieve (the first page is 1). See Pagination for more information.

​
per_page
integer

The number of campaigns to be returned per page (max is 100). See Pagination for more information.

​
delivery_type
string

Optional parameter to filter the results by the gift type. Valid options are mail which returns all physical item campaigns or email which returns all eGift campaigns.

​
Response

​
current_page
integer
required

The current page being returned (used for pagination purposes).

​
per_page
integer
required

The number of results being returned per page (used for pagination purposes).

​
total_posts
integer
required

The total number of campaigns (used for pagination purposes).

​
touches
array
required

List of campaigns

​
id
integer
required

The campaign’s identifier.

​
name
string
required

The campaign’s name.

​
start_date
string
required

The campaign’s start date (in ISO 8601 format). Gifts cannot be sent for this campaign before this start date.

​
end_date
string

The campaign’s end date (in ISO 8601 format). Gifts cannot be sent for this campaign after this end date.

​
description
string
required

The campaign’s description.

​
created_at
string
required

The campaign’s creation date (in ISO 8601 format).

​
user_id
integer
required

The identifier of the user that created this campaign.

​
gift_id
integer
required

The campaign’s general gift identifier.

​
starting_egift_price
number

The campaign’s starting_egift_price and ending_egift_price represent the range amount from which the sender can pick the egift denominiation to send. Only present for eGift campaigns. When this range is present, is_default_price will be false.

​
ending_egift_price
number

The campaign’s starting_egift_price and ending_egift_price represent the range amount from which the sender can pick the egift denominiation to send. Only present for eGift campaigns. When this range is present, is_default_price will be false.

​
status
string
required

The campaign’s status. It will ALWAYS be Active since this endpoint only returns active campaigns.

​
is_default_price
boolean
required

Whether or not the sender can pick the eGift amount from a range or if it is a set price.

​
delivery_type
string
required

The type of gift that is associated to this campaign. Valid options are mail which means physical item or email which means eGift.

​
hubspot_key
string
required

The campaign’s key to be used for HubSpot integration.

​
ship_to_countries
array
required

List of countries that this campaign’s gift(s) can be sent to (in ISO 3166-1 alpha-2 format).

​
currency
string
required

The campaign’s gift currency (in ISO 4217 format).

Get All Team Group UsersGet Campaign