solarOSsolarOS Docs

List Campaigns

Lists tenant-scoped Campaign records with cursor pagination, status/type/isActive filters, sorting, and External References. Supply externalSystem, externalObject, and externalId together to filter by a canonical External Reference. Required scope: campaigns:read.

GET
/campaigns

Lists tenant-scoped Campaign records with cursor pagination, status/type/isActive filters, sorting, and External References. Supply externalSystem, externalObject, and externalId together to filter by a canonical External Reference. Required scope: campaigns:read.

Authorization

Authorization<token>

Organization API key. Format: Bearer sk_live_...

In: header

Query Parameters

limit?integer

Maximum number of Campaigns to return. Values above 100 are capped at 100.

Rangevalue <= 100
cursor?string

Opaque pagination cursor from the previous response meta.nextCursor value.

status?string

Filter Campaigns by integration-defined status.

type?string

Filter Campaigns by integration-defined campaign type.

isActive?string

Filter active or inactive Campaigns.

Value in

  • "true"
  • "false"
sortDir?string

Sort direction for createdAt/id ordering.

Value in

  • "asc"
  • "desc"
externalSystem?string

External Reference system filter. Supply with externalObject and externalId for exact reconciliation lookup.

externalObject?string

External Reference object filter. Supply with externalSystem and externalId.

externalId?string

External Reference id filter. Supply with externalSystem and externalObject.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/campaigns"
{  "data": [    {}  ],  "meta": {    "nextCursor": "string",    "hasMore": true,    "requestId": "string",    "version": "v1",    "timestamp": "2019-08-24T14:15:22Z",    "rateLimit": {      "limit": 0,      "remaining": 0,      "reset": 0    }  }}