List contracts for a company
GET/companies/:companyID/contracts
List contracts for a company
Request
Path Parameters
Query Parameters
Default value: 1
Possible values: >= 1 and <= 100
Default value: 20
Responses
- 200
success - paginated list of contracts
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
data
object[]
required
Catalogue name, falling back to the referential name.
Possible values: [custom, referential]
Explicit product kind: 'custom' when a custom_product row references this entry, 'referential' when it points to a referential product. Derived from the data, not from the unreliable productSource column.
establishment
object
nullable
required
Identifier of the insurer institution, null when only free-text insurer is known.
Insurer/establishment name (e.g. MMA, AFI ESCA), from the linked institution, falling back to the referential free-text insurer.
pagination
object
required
Current pagination page
Number of items per page
Total number of matching items
Total number of pages
{
"data": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"referentialId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"type": "custom",
"isActive": true,
"establishment": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string"
},
"marketed": true,
"commercializationStart": "string",
"commercializationEnd": "string"
}
],
"pagination": {
"page": 0,
"limit": 0,
"total": 0,
"totalPages": 0
}
}