Skip to main content
GET
/
companies
/
v2
/
rs
/
{companyId}
/
contracts
/
{contractId}
Get contract
curl --request GET \
  --url https://z52mnqg347.execute-api.eu-west-3.amazonaws.com/main/companies/v2/rs/{companyId}/contracts/{contractId} \
  --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"
    },
    "updatableFields": {
      "name": true,
      "description": true,
      "siteRules": true,
      "profileRules": true,
      "reference": true,
      "duration": true,
      "interventionCount": true,
      "startAt": true
    }
  }
}

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
enum<string>
required

Content type, must be "application/json".

Available options:
application/json

Path Parameters

​
companyId
integer
required

Unique identifier of the company.

Example:

1

​
contractId
integer
required

Unique identifier of the contract.

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

  • "updatable-fields": Get information about the field that can be updated

Available options:
count-profiles,
count-rules,
count-sites,
active-document,
updatable-fields
​
includeCount
boolean
default:false

Include total count in response.

Example:

true

​
page
integer
default:1

Page number.

Example:

1

​
pageSize
integer
default:50

Page size.

Example:

50

​
findId
integer

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

Example:

1

​
subPageSize
integer
default:10

Sub page size for grouping items.

Example:

10

Response

200 - application/json

Get contract

​
data
object
required