Skip to main content
GET
Contracts with every field of the records each row points at: owner, site, vendor.

Headers

Range
string

Limiting and Pagination

Range-Unit
string
default:items

Limiting and Pagination

Prefer
enum<string>

Preference

Available options:
count=none

Query Parameters

id
string
contract_number
string
name
string
contract_type
string
contract_type_name
string
contract_category
string
status
string
status_label
string
status_category
string
vendor_id
string
vendor_number
string
vendor_name
string
site_id
string
site_code
string
site_name
string
start_date
string
end_date
string
signed_on
string
auto_renew
string
renewal_notice_days
string
contract_value
string
contract_value_currency_id
string
covers_parts
string
covers_labour
string
covers_travel
string
requires_authorized_vendor
string
scope
string
exclusions_summary
string
owner_name
string
external_reference
string
notes
string
is_live
string
has_expired
string
days_remaining
string
in_renewal_window
string
named_assets
string
covered_asset_categories
string
visits_included
string
visits_used
string
claims
string
custom_fields
string
row_version
string
created_at
string
created_by_id
string
created_by_name
string
created_source
string
updated_at
string
updated_by_id
string
updated_by_name
string
owner__email
string
owner__username
string
owner__sign_in_handle
string
owner__name
string
owner__phone
string
owner__status
string
owner__last_login_at
string
owner__worker_number
string
owner__worker_name
string
owner__worker_type
string
owner__worker_is_active
string
owner__worker_teams
string
site__code
string
site__name
string
site__timezone
string
site__is_active
string
site__company_name
string
site__business_unit_name
string
site__business_unit_parent_name
string
site__asset_count
string
vendor__vendor_number
string
vendor__name
string
vendor__vendor_type
string
vendor__is_oem
string
vendor__status
string
vendor__status_label
string
vendor__status_category
string
vendor__email
string
vendor__phone
string
vendor__website
string
vendor__payment_terms_days
string
vendor__onboarded_on
string
vendor__approved_on
string
vendor__performance_score
string
vendor__usable
string
vendor__categories
string
vendor__site_count
string
vendor__active_contracts
string
vendor__best_response_minutes
string
vendor__average_rating
string
vendor__rating_count
string
vendor__open_work_orders
string
vendor__warranty_work_orders
string
vendor__open_claims
string
vendor__is_assignable
string
vendor__compliance_expiring
string
vendor__warranty_authorisations
string
vendor__custom_fields
string
vendor__created_at
string
vendor__created_by_name
string
vendor__updated_at
string
vendor__updated_by_name
string
reference_records
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

Response

OK

auto_renew
boolean<boolean>
claims
integer<bigint>
contract_category
string<character varying>
Maximum string length: 30
contract_number
string<character varying>
Maximum string length: 60
contract_type
string<character varying>
Maximum string length: 40
contract_type_name
string<character varying>
Maximum string length: 150
contract_value
number<numeric>
contract_value_currency_id
string<uuid>

Note: This is a Foreign Key to asset_cost_to_keep.currency_id.

covered_asset_categories
integer<bigint>
covers_labour
boolean<boolean>
covers_parts
boolean<boolean>
covers_travel
boolean<boolean>
created_at
string<timestamp with time zone>
created_by_id
string<uuid>

Note: This is a Foreign Key to capex_invite_candidates.id.

created_by_name
string<character varying>
Maximum string length: 200
created_source
string<text>
custom_fields
string<jsonb>
days_remaining
integer<integer>
end_date
string<date>
exclusions_summary
string<text>
external_reference
string<character varying>
Maximum string length: 120
has_expired
boolean<boolean>
id
string<uuid>

Note: This is a Primary Key.

in_renewal_window
boolean<boolean>
is_live
boolean<boolean>
name
string<character varying>
Maximum string length: 200
named_assets
integer<bigint>
notes
string<text>
owner__email
string<public.citext>
owner__last_login_at
string<timestamp with time zone>
owner__name
string<character varying>
Maximum string length: 200
owner__phone
string<character varying>
Maximum string length: 40
owner__sign_in_handle
string<text>
owner__status
string<character varying>
Maximum string length: 30
owner__username
string<public.citext>
owner__worker_is_active
boolean<boolean>
owner__worker_name
string<character varying>
Maximum string length: 200
owner__worker_number
string<character varying>
Maximum string length: 60
owner__worker_teams
string<jsonb>
owner__worker_type
string<character varying>
Maximum string length: 150
owner_name
string<character varying>
Maximum string length: 200
reference_records
string<jsonb>
renewal_notice_days
integer<integer>
requires_authorized_vendor
boolean<boolean>
row_version
integer<bigint>
scope
string<text>
signed_on
string<date>
site__asset_count
integer<bigint>
site__business_unit_name
string<character varying>
Maximum string length: 200
site__business_unit_parent_name
string<character varying>
Maximum string length: 200
site__code
string<character varying>
Maximum string length: 50
site__company_name
string<character varying>
Maximum string length: 200
site__is_active
boolean<boolean>
site__name
string<character varying>
Maximum string length: 200
site__timezone
string<character varying>
Maximum string length: 100
site_code
string<character varying>
Maximum string length: 50
site_id
string<uuid>

Note: This is a Foreign Key to entry_currencies.for_site_id.

site_name
string<character varying>
Maximum string length: 200
start_date
string<date>
status
string<character varying>
Maximum string length: 60
status_category
string<character varying>
Maximum string length: 20
status_label
string<text>
updated_at
string<timestamp with time zone>
updated_by_id
string<uuid>

Note: This is a Foreign Key to capex_invite_candidates.id.

updated_by_name
string<character varying>
Maximum string length: 200
vendor__active_contracts
integer<bigint>
vendor__approved_on
string<date>
vendor__average_rating
number<numeric>
vendor__best_response_minutes
integer<integer>
vendor__categories
string<jsonb>
vendor__compliance_expiring
integer<bigint>
vendor__created_at
string<timestamp with time zone>
vendor__created_by_name
string<character varying>
Maximum string length: 200
vendor__custom_fields
string<jsonb>
vendor__email
string<public.citext>
vendor__is_assignable
boolean<boolean>
vendor__is_oem
boolean<boolean>
Maximum string length: 250
vendor__name
string<character varying>
Maximum string length: 200
vendor__onboarded_on
string<date>
vendor__open_claims
integer<bigint>
vendor__open_work_orders
integer<bigint>
vendor__payment_terms_days
integer<integer>
vendor__performance_score
number<numeric>
vendor__phone
string<character varying>
Maximum string length: 40
vendor__rating_count
integer<bigint>
vendor__site_count
integer<bigint>
vendor__status
string<character varying>
Maximum string length: 60
vendor__status_category
string<character varying>
Maximum string length: 20
vendor__status_label
string<text>
vendor__updated_at
string<timestamp with time zone>
vendor__updated_by_name
string<character varying>
Maximum string length: 200
vendor__usable
boolean<boolean>
vendor__vendor_number
string<character varying>
Maximum string length: 60
vendor__vendor_type
string<character varying>
Maximum string length: 40
vendor__warranty_authorisations
integer<bigint>
vendor__warranty_work_orders
integer<bigint>
vendor__website
string<character varying>
Maximum string length: 250
vendor_id
string<uuid>

Note: This is a Foreign Key to assignable_vendors.id.

vendor_name
string<character varying>
Maximum string length: 200
vendor_number
string<character varying>
Maximum string length: 60
visits_included
integer<bigint>
visits_used
integer<bigint>