Skip to main content
GET
List contracts

Authorizations

Authorization
string
header
required

OAuth 2.1 authorization code + PKCE (S256). Tokens are tenant-bound (company_id) and scoped. Discover endpoints via /.well-known/oauth-authorization-server.

Query Parameters

limit
integer
default:25

Page size (default 25, max 100). Messaging lists on SideShift's own messaging clamp values above 50 to 50.

Required range: 1 <= x <= 100
cursor
string

Opaque pagination cursor from a prior response's nextCursor.

status
string
programId
string
creatorId
string
groupBy
enum<string>

groupBy=campaign returns a per-campaign contract rollup instead of contract rows — one read where callers previously fetched contracts per campaign in a loop. Pagination and the row filters do not apply to the rollup.

Available options:
campaign

Response

A page of contracts.

nextCursor
string | null
required
hasMore
boolean
required
data
object[]
required