Skip to main content
GET
List sub-publishing agreements
This endpoint requires authentication. Include your Bearer token in the Authorization header.

Description

GET /publisher/sub-publishing publisherId is optional — omitted, this returns every sub-publishing agreement for the tenant (the Sub-Publishing list page is tenant-wide). When provided, scopes to that publisher on the side indicated by type (original default, or sub). Authorization: user role + publisher addon.

Code Examples

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"

Query Parameters

publisherId
string<uuid>
type
enum<string>
default:original

Only meaningful together with publisherId.

Available options:
original,
sub
status
enum<string>
Available options:
active,
inactive

Response

Agreements fetched (includes originalPublisher/subPublisher summaries), ordered by startDate DESC.

id
string<uuid>
originalPublisherId
string<uuid>
subPublisherId
string<uuid>
tenantId
integer
agreementNumber
string
startDate
string<date-time>
endDate
string<date-time> | null
terms
object
originalPublisher
object | null

Included on GET responses — { id, name, publisherType }.

subPublisher
object | null

Included on GET responses — { id, name, publisherType }.

createdAt
string<date-time>
updatedAt
string<date-time>