Skip to main content
GET
/
companies
/
v2
/
rs
/
{companyId}
/
contracts
List contracts
curl --request GET \
  --url https://z52mnqg347.execute-api.eu-west-3.amazonaws.com/main/companies/v2/rs/{companyId}/contracts \
  --header 'Authorization: Bearer <token>' \
  --header 'content-type: <content-type>' \
  --header 'x-session-token: <x-session-token>'
{
  "data": [
    {
      "id": 1,
      "name": "Service Agreement",
      "description": "Annual renewal pending approval.",
      "type": 1,
      "status": 1,
      "companyId": 123,
      "archivedAt": "2024-12-01T12:34:56.000Z",
      "updatedAt": "2024-12-01T12:34:56.000Z",
      "createdAt": "2024-01-15T09:30:00.000Z",
      "countProfiles": 3,
      "countRules": 10,
      "countSites": 5,
      "activeDocument": {
        "id": 1,
        "reference": "Service Agreement",
        "duration": 12,
        "interventionCount": 5,
        "startAt": "2024-01-15T09:30:00.000Z",
        "dueAt": "2025-01-15T09:30:00.000Z",
        "createdAt": "2024-01-15T09:30:00.000Z"
      },
      "actions": {
        "canBeUpdated": true,
        "canBeDeleted": true
      }
    }
  ],
  "totalCount": 100,
  "pagination": {
    "page": 1,
    "pageSize": 50
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-session-token
string
required

Session token used for authenticating the request.

Example:

"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiIxMjM0NTY3ODkwIiwic2Vzc2lvbklkIjoiYWJjZGVmMTIzNDU2IiwiaWF0IjoxNjA1MDk3ODk5LCJleHAiOjE2MDUxODQyOTl9.4XRQ1iXDyvEj5LgPZHbmTmzOZs98M3YPOzgf3MhxjaI"

​
content-type
string
required

Content type, must be "application/json".

Allowed value: "application/json"

Path Parameters

​
companyId
integer
required

Unique identifier of the company.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

1

Query Parameters

​
extend
enum<string>[]

Extend options:

  • "count-profiles": Get the number of profiles in the contract

  • "count-rules": Get the number of rules in the contract

  • "count-sites": Get the number of sites in the contract

  • "active-document": Get the active document in the contract

  • "actions-info": Give information about actions that can be done on the contract

Available options:
count-profiles,
count-rules,
count-sites,
active-document,
actions-info
​
whereName
string

Filter by name

Example:

"string"

​
whereType
integer[]

Filter by type

Required range: -9007199254740991 <= x <= 9007199254740991
Example:
[1, 2, 3]
​
whereStatus
integer[]

Filter by status

Required range: -9007199254740991 <= x <= 9007199254740991
Example:
[1, 2, 3]
​
whereDescription
string

Filter by description

Example:

"string"

​
whereSiteIds
integer[]

Filter by sites

Required range: -9007199254740991 <= x <= 9007199254740991
Example:
[1, 2, 3]
​
whereRuleIds
integer[]

Filter by rules

Required range: -9007199254740991 <= x <= 9007199254740991
Example:
[1, 2, 3]
​
whereProfileIds
integer[]

Filter by profiles

Required range: -9007199254740991 <= x <= 9007199254740991
Example:
[1, 2, 3]
​
whereIsArchived
boolean

Filter by archived status

Example:

true

​
whereArchivedAt
string

Filter by archivedAt

Example:

"2021-01-01T00:00:00.000Z"

​
whereCreatedAt
string

Filter by createdAt

Example:

"2021-01-01T00:00:00.000Z"

​
whereText
string

Filter by name or location

Example:

"string"

​
orderBy
object[]
​
includeCount
boolean
default:false

Include total count in response.

Example:

true

​
page
integer
default:1

Page number.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

1

​
pageSize
integer
default:50

Page size.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

50

​
findId
integer

Get the page where the item with this id is located.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

1

​
subPageSize
integer
default:10

Sub page size for grouping items.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

10

Response

200 - application/json

List contracts

​
data
object[]
required
​
totalCount
integer

Total count of items.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

100

​
pagination
object

Pagination information.