Sign in

v1

latestOpenAPI 3.0.02026-07-24161215397.4 KB
Contracts

Retrieve all contracts.

Retrieve a list of contracts based on provided filters

Required scopes: flex.community.contracts.read

get/api/v2/organizations/{orgSlug}/contracts

Path parameters

orgSlugstring required

organization slug

Query parameters

_idstring
Example:6080186f490fcf6e0547ec52

Filter by the exact id of the contract.

companystring
Example:6080186f490fcf6e0547ec55

Filter by the id of the company associated with the contract

locationstring
Example:6080186f490fcf6e0547ec58

Filter by the id of the location associated with the contract.

status'signed' | 'draft' | 'terminated' | 'not_signed' | 'canceled'

The status of the contract.

Filter by the status of the contract.

stage'terminated' | 'served_notice' | 'active' | 'up_for_renewal' | 'not_renewed' | 'expired' | 'rolling'

The stage of the contract.

Filter by the stage of the contract.

createdAtstring
Example:createdAt[$gte]=YYYY-MM-DDTHH:mm:ssZ

Support date comparison filters: $gt, $gte, $lt, $lte

modifiedAtstring
Example:modifiedAt[$gte]=YYYY-MM-DDTHH:mm:ssZ

Support date comparison filters: $gt, $gte, $lt, $lte

$selectstring

Select fields to return

$cursorNextstring
$cursorPrevstring
$limitnumber
$sortstring
Example:propertyName:asc

Sort expression in the format <field>:<order>, where order is asc or desc

Response

rangeStartnumber
rangeEndnumber
cursorNextstring
cursorPrevstring

Example response

{
  "results": [
    {
      "notice": {
        "months": 3
      },
      "properties": {
        "customProperty1": "value1",
        "customProperty2": "value2"
      },
      "_id": "6080186f490fcf6e0547ec57",
      "number": "CON-3",
      "company": "6080186f490fcf6e0547ec59",
      "member": "6080186f490fcf6e0547ec57",
      "location": "6080186f490fcf6e0547ec58",
      "deal": {
        "dealId": "deal-123",
        "dealName": "Membership deal",
        "crmLink": "https://crm.example.com/deals/deal-123"
      },
      "documentType": "membershipagreement",
      "startDate": "2024-08-21T00:00:00.000Z",
      "endDate": "2025-08-20T00:00:00.000Z",
      "plans": [],
      "oneOffPlans": [],
      "resources": [],
      "legalDocuments": [
        "6080186f490fcf6e0547ec85",
        "6080186f490fcf6e0547ec59"
      ],
      "addendum": "<p> This is an example addendum to the contract. </p>",
      "isRolling": true,
      "signDate": "2024-08-21T16:00:00.000Z",
      "signedBy": {
        "_id": "6080186f490fcf6e0547ec50",
        "displayName": "John Doe"
      },
      "activationErrors": [],
      "termination": {
        "date": "2024-08-21T00:00:00.000Z",
        "reasonKey": "Example Reason Key",
        "comments": "Example Comment"
      },
      "total": 150.5,
      "baseTotal": 145.62,
      "plansTotal": 120.81,
      "oneOffsTotal": 15.522,
      "resourcesTotal": 15.99,
      "percentagePriceIncrease": 10,
      "previousDepositHeld": 100,
      "renewedContract": "6080186f490fcf6e0547ec57",
      "renewalContract": "6080186f490fcf6e0547ec58",
      "createdAt": "2024-08-21T16:00:00.000Z",
      "createdBy": "6080186f490fcf6e0547ec50",
      "modifiedAt": "2024-08-21T16:00:00.000Z",
      "modifiedBy": "6080186f490fcf6e0547ec50"
    }
  ]
}