Get an account's campaigns or offers

Return an account’s campaigns or offers, newest start date first. datePreset, or startDate and endDate, filter by campaign start date. Omit both for all time.

Limited to 120 requests per minute per user. Costs $0.0005 per campaign returned, charged against your plan’s monthly credits. The count field is what you were charged for.

Authentication

AuthorizationBearer

An API key from Settings → API, prefixed sg_live_.

Path parameters

idstringRequired

Brand id returned by POST /brands/search.

Query parameters

typeenumRequired

Allowed values:

sortByenumOptional

Allowed values:

limitintegerOptional1-100Defaults to 10

datePresetenumOptional

startDatestringOptional

endDatestringOptional

Response

Campaigns or offers for the account.

countinteger

campaignslist of objects

Errors

400

Bad Request Error

401

Unauthorized Error

402

Payment Required Error

403

Forbidden Error

404

Not Found Error

405

Method Not Allowed Error

429

Too Many Requests Error

500

Internal Server Error