CLIENT API / V1 CONTENT, BRIEFS & CAMPAIGNS

List briefs

GET/sites/{site_id}/briefscontent:read

OVERVIEW

List briefs. Only explicitly granted sites and permissions are accessible. No credentials or raw worker payloads are returned. Lists omit large bodies; detail calls return stored payloads with bounded exports. Parent/child ownership is checked before artifact retrieval. GET never generates, revises, reviews or publishes content.

Request	`GET https://satelliteai.io/api/v1/sites/{site_id}/briefs`
Permission	`content:read`
Response	A list (cursor or offset paginated): `data` is `array of ContentBriefListItem`.
Operation ID	`listContentBriefs`

More context and worked examples are in the developer guide.

REQUEST

Example request

cURL · Bash

curl --fail-with-body \
  'https://satelliteai.io/api/v1/sites/123/briefs' \
  -H "Authorization: Bearer $SATELLITE_API_KEY"

Replace the example IDs with values returned by the discovery endpoints. Example values are placeholders, not real records.

Parameters

Name	In	Type	Description
`site_id`required	path	integer	Authorized site id. Parent and site grants must also match. min 1 · max 9223372036854775807
`limit`	query	integer	Maximum records per page. Default 50, maximum 100. default 50 · min 1 · max 100
`cursor`	query	string	Opaque next_cursor from the prior page; expires after 24 hours. Preserve all filters.
`status`	query	string	Exact case-sensitive stored status; supported on resources with a status column. No status filter on campaign claims. max length 40

Unknown or repeated query parameters return 400.

RESPONSE

Data dictionary

Scoped result. Lists return pagination metadata; unavailable records return 404. Compact list row; retrieve the detail endpoint for body and review fields.

[] marks an array element. nullable means the value can be null; treat it as unknown, not zero. always present means the key is always included in the object.

Fields in data
Field	Type	Description
`data[].id`	integernullable	Id.
`data[].site_id`	integernullable	Site id.
`data[].page_url`	stringnullable	Page url.
`data[].version`	integernullable	Version.
`data[].brief_version`	integernullable	Brief version.
`data[].status`	stringnullable	Status.
`data[].created_at`	stringnullable	Created at. Stored UTC ISO 8601 timestamp; legacy values may omit a timezone suffix.
`data[].updated_at`	stringnullable	Updated at. Stored UTC ISO 8601 timestamp; legacy values may omit a timezone suffix.
`data[].truncated_fields`	array of string	Scalar text fields truncated at 200000 characters. Empty when no scalar was truncated.

Response metadata

Fields in meta
Field	Type	Description
`meta.request_id`	stringalways present	Request identifier; also returned in X-Request-ID. Include it in support requests.
`meta.api_version`	stringalways present	API version that produced the response. one of: v1
`meta.limit`	integer	Applied page size; default 50, maximum 100.
`meta.has_more`	boolean	Whether another page exists.
`meta.next_cursor`	stringnullable	Opaque next-page cursor, null at the end. Cursors expire after 24 hours.
`meta.availability`	string	available when stored data exists; not_available when it does not. one of: available, not_available
`meta.billing`	object	Present for paid live SERP requests; replayed receipts describe the original debit, not an additional charge.
`meta.billing.operation`	stringalways present	one of: client_api_serp_refresh
`meta.billing.credits_charged`	integeralways present	min 0
`meta.billing.transaction_id`	integeralways present
`meta.billing.replayed`	booleanalways present

ERRORS

Error responses

Errors return {"error": {"code", "message", "request_id"}}. See error handling for retry guidance.

HTTP	When
`400`	Invalid parameters
`401`	Invalid credentials
`403`	Missing permission
`404`	Missing or inaccessible resource
`413`	artifact_too_large: the authorized stored export exceeds 2 MiB or bounded retrieval limits.
`503`	artifact_unavailable or ownership_unavailable: stored artifact cannot be safely retrieved.