COconnexcs
Contract

Read

Changed on

Retrieve a single Contract record by ID.

get/api/cp/contract/{id}

Request

  • Base URL
    https://app.connexcs.com
  • Auth
    • OAuth 2
      Authorization code: https://auth.connexcs.com/authorize
      Token URL: https://auth.connexcs.com/token
    • or HTTP bearer

Path parameters

idinteger required

Id identifier

Response

Successful response

idinteger

Id

contract_rev_idinteger

Contract Rev Id (references contract_rev.id)

company_idinteger

Company Id

route_ingress_idinteger

Route Ingress Id

requiredinteger

Required

date_createdstring date-time

Date Created

date_gracestring date-time

Date Grace

date_approvedstring date-time

Date Approved

approved_bystring

Approved By

identity_idstring

Identity Id

Example response

{
  "id": 12345,
  "contract_rev_id": 1,
  "company_id": 1,
  "route_ingress_id": 1,
  "required": 1,
  "date_created": "2025-01-17T10:30:00Z",
  "date_grace": "2025-01-17T10:30:00Z",
  "date_approved": "2025-01-17T10:30:00Z",
  "approved_by": "example_approved_by",
  "identity_id": 1
}

Changes

  • fa097c4785b8Revision changes
    • info

      the endpoint scheme security oAuth2 was added to the API

    • info

      the endpoint scheme security opaqueToken was added to the API

    • info

      the endpoint scheme security basicAuth was removed from the API