GET /ads

Retrieve a list of Ads belonging to the Advertisable

Servers

Query parameters

Name Type Required Description
page Integer No

Page number of records to return

Default value: 1

sort String No

Name(s) of the field to sort by. e.g. "eid" returns the eid property, in ascending order. "name desc" returns the name property, in descending order. "name desc, eid" returns the name property in descending order and then eid in ascending order.

all String No

Return all Ads of the given advertisable(s). Note using this query param may have performance concern, compared to paginated calls.

Possible values:

  • "true"
page_size Integer No

Number of records on each page

Default value: 10

advertisable String Yes

EID of the Advertisable.

Default value: "Current User's Advertisable EID."

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.