Skip to main content
GET
List contract users

Authorizations

Api-Token
string
header
required

Server-to-server authentication. Generate a token in the admin UI at Settings → Developers → API Access. Send the raw token in the Api-Token header — there is no Bearer prefix.

Tokens can be marked read-only at creation time, in which case the API rejects any non-GET request with 403 Forbidden.

Query Parameters

page
integer
default:1

The collection page number

itemsPerPage
integer
default:30

The number of items per page

Required range: 0 <= x <= 100
pagination
boolean

Enable or disable pagination

contract
string
contract[]
string[]
user
string
user[]
string[]
user.lastName
string
contact
string
contact[]
string[]
isLocked
boolean
isLocked[]
boolean[]
contract.unit
string
contract.unit[]
string[]
status
string
status[]
string[]
order[dateSignature]
enum<string>
default:asc
Available options:
asc,
desc
order[id]
enum<string>
default:asc
Available options:
asc,
desc
order[dateValidityEnd]
enum<string>
default:asc
Available options:
asc,
desc
order[status]
enum<string>
default:asc
Available options:
asc,
desc
exists[canceledBy]
boolean

Response

200 - application/json

ContractUser collection

id
integer
read-only
contract
object
user
object | null
isLocked
boolean | null
media
object | null
dateSignature
string<date-time> | null
canceledBy
object | null
dateValidityEnd
string<date-time> | null
dateValidityStart
string<date-time> | null
contact
object | null
status
string | null
default:unsigned
contractNumber
integer | null