curl --request GET \
--url https://ywe3crmpll.execute-api.us-east-2.amazonaws.com/stage/maintenance-agreements \
--header 'x-api-key: <api-key>'import requests
url = "https://ywe3crmpll.execute-api.us-east-2.amazonaws.com/stage/maintenance-agreements"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://ywe3crmpll.execute-api.us-east-2.amazonaws.com/stage/maintenance-agreements', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"message": "Unauthorized"
}Get Maintenance Agreements
curl --request GET \
--url https://ywe3crmpll.execute-api.us-east-2.amazonaws.com/stage/maintenance-agreements \
--header 'x-api-key: <api-key>'import requests
url = "https://ywe3crmpll.execute-api.us-east-2.amazonaws.com/stage/maintenance-agreements"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://ywe3crmpll.execute-api.us-east-2.amazonaws.com/stage/maintenance-agreements', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"message": "Unauthorized"
}Query Parameters
Optional text search. Empty or whitespace is ignored. A non-empty value is matched, case-insensitively, against the agreement title and job location, the location address, and the customer first name, last name, company name, email, and phone. A positive numeric value also matches the agreement cuid exactly.
Optional relation map, sent as rel[name]. Only the keys are read. A key in the allowed list is eager loaded with the view's column set. Any other key is ignored. The value is not used.
Keys
- customer,
- customerContact,
- entityLocation,
- routines,
- routines.scheduleGenerationMethod,
- routines.onDemandGenerationMethod,
- routines.scheduleGenerationMethod.jobTemplate,
- routines.onDemandGenerationMethod.jobTemplate,
- lastServiceRoutine,
- lastInvoice,
- lastJob,
- custom_status,
- status_workflow,
- billingRoutines