Organization API

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.

/api/v1/campaigns

List Campaigns. Use an organization API key with campaigns:read. Check the response envelope and meta.requestId before triggering dependent workflow steps.

Required scopes

campaigns:read

Parameters

Name	In	Type	Description
limit	query	integer	Maximum number of Campaigns to return. Values above 100 are capped at 100.
cursor	query	string	Opaque pagination cursor from the previous response meta.nextCursor value.
status	query	string	Filter Campaigns by integration-defined status.
type	query	string	Filter Campaigns by integration-defined campaign type.
isActive	query	true \| false	Filter active or inactive Campaigns.
sortDir	query	asc \| desc	Sort direction for createdAt/id ordering.
externalSystem	query	string	External Reference system filter. Supply with externalObject and externalId for exact reconciliation lookup.
externalObject	query	string	External Reference object filter. Supply with externalSystem and externalId.
externalId	query	string	External Reference id filter. Supply with externalSystem and externalObject.

Request body

This endpoint does not accept a JSON request body.

Responses

200

Campaign list envelope

#/components/schemas/OrgApiListEnvelope

400

Unsupported filter or sort