{ "opencollection": "1.0.0", "info": { "name": "Clozd Data /programs/:program Id/competitors /programs/:program Id/competitors API", "version": "v3.0" }, "items": [ { "info": { "name": "/programs/:program_id/competitors", "type": "folder" }, "items": [ { "info": { "name": "Get list of competitors", "type": "http" }, "http": { "method": "GET", "url": "https://app.clozd.com/public-api/v3/programs/:program_id/competitors", "params": [ { "name": "limit", "value": "100", "type": "query", "description": "Limit for paging (min:1, max:1000)" }, { "name": "offset", "value": "200", "type": "query", "description": "Offset for paging (min:0, max:100000)" }, { "name": "include", "value": "deals,responses", "type": "query", "description": "Specifies type of data to include with competitor. NOTE: Cannot include 'responses' without also including 'deals'. (maxItems:2)" }, { "name": "filter", "value": "", "type": "query", "description": "Returns only competitors updated since the date and time specified. Specifying this parameter will enable periodic query of incremental changes since the last pull (instead of always having to pull all competitors). (max:25 chars, ISO8601 date-time format)" }, { "name": "program_id", "value": "2427ee0e-fc37-4537-ae83-b648d5a7c7f5", "type": "path", "description": "Clozd program ID (min:36 chars, max:36 chars)" } ], "auth": { "type": "apikey", "key": "x-api-token", "value": "{{x-api-token}}", "placement": "header" } }, "docs": "Get a paginated list of competitors for a program (optionally with deals and responses referenced by competitors). Make sure the header is set with a key value pair being Key: x-api-token Value: (api token provided from the settings section within the Clozd application).\n - :program_id is required, you can get the program id from the settings page within the Clozd app." } ] } ], "bundled": true }