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

Description

GET /publisher-writer/agreements Description: Returns agreements for the tenant matching the supplied filters, each with publisher and writer eagerly loaded (INNER JOIN — an agreement whose publisher or writer was hard-deleted will not appear). Not paginated — returns the full matching set as a bare array. Authorization:
  • Required role: user or higher
Method: GET

Code Examples

Authorizations

Authorization
string
header
required

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

Query Parameters

publisherId
string<uuid>
writerId
string<uuid>
status
enum<string>
Available options:
draft,
pending,
active,
expired,
terminated
isActive
enum<string>

Compared as the literal string 'true'; any other value is treated as false.

Available options:
true,
false
startDate
string<date>

Matches agreements with startDate >= this date.

endDate
string<date>

Matches agreements with endDate <= this date.

Response

Agreements retrieved

id
string<uuid>
tenantId
integer
publisherId
string<uuid>
writerId
string<uuid>
name
string
description
string | null
territories
object[]
contractNumber
string | null
contractDate
string<date-time> | null
startDate
string<date-time> | null
endDate
string<date-time> | null
status
enum<string>
Available options:
draft,
pending,
active,
expired,
terminated
isActive
boolean
default:true
publisher
object

Only present when the record was loaded via the model's default scope (all reads; NOT present on the POST /agreements create response).

writer
object

Only present when the record was loaded via the model's default scope (all reads; NOT present on the POST /agreements create response).

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