Show requirement
curl --request GET \
--url https://app.yampi.ai/api/v1/accounts/{account_id}/requirements/{id} \
--header 'api_access_token: <api-key>'const options = {method: 'GET', headers: {api_access_token: '<api-key>'}};
fetch('https://app.yampi.ai/api/v1/accounts/{account_id}/requirements/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://app.yampi.ai/api/v1/accounts/{account_id}/requirements/{id}"
headers = {"api_access_token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"category": "<string>",
"id": 123,
"display_id": 123,
"account_id": 123,
"requirement_type": "<string>",
"status": "<string>",
"priority": "<string>",
"source": "<string>",
"title": "<string>",
"description": "<string>",
"responsible_party": "<string>",
"tenant_share_percent": 123,
"approval_status": "<string>",
"approval_forced": true,
"cost_estimate": 123,
"classification": {},
"property_id": 123,
"conversation_id": 123,
"assignee_id": 123,
"reporter_contact_id": 123,
"duplicate_of_id": 123,
"approval_required": true,
"sign_off_required": true,
"owner_portal_enabled": true,
"classification_editable": true,
"approval_requested_at": "<string>",
"classification_options": [
{
"id": "<string>",
"types": [
{
"id": "<string>",
"approval_threshold": 123,
"classification": {
"required": [
"<string>"
],
"optional": [
"<string>"
]
},
"termination_canons": {},
"resolution_business_days": 123
}
]
}
],
"created_at": "<string>",
"updated_at": "<string>",
"labels": [
"<string>"
],
"classification_tenancies": [
{
"id": 123,
"status": "<string>",
"label": "<string>",
"contract_end_date": "<string>",
"canon": "<string>",
"cycles": [
{
"id": 123,
"period_start_on": "<string>",
"amount_due": "<string>",
"status": "<string>"
}
]
}
]
}{
"description": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
]
}{}{}Requirements
Show requirement
Get one capture requirement.
GET
/
api
/
v1
/
accounts
/
{account_id}
/
requirements
/
{id}
Show requirement
curl --request GET \
--url https://app.yampi.ai/api/v1/accounts/{account_id}/requirements/{id} \
--header 'api_access_token: <api-key>'const options = {method: 'GET', headers: {api_access_token: '<api-key>'}};
fetch('https://app.yampi.ai/api/v1/accounts/{account_id}/requirements/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://app.yampi.ai/api/v1/accounts/{account_id}/requirements/{id}"
headers = {"api_access_token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"category": "<string>",
"id": 123,
"display_id": 123,
"account_id": 123,
"requirement_type": "<string>",
"status": "<string>",
"priority": "<string>",
"source": "<string>",
"title": "<string>",
"description": "<string>",
"responsible_party": "<string>",
"tenant_share_percent": 123,
"approval_status": "<string>",
"approval_forced": true,
"cost_estimate": 123,
"classification": {},
"property_id": 123,
"conversation_id": 123,
"assignee_id": 123,
"reporter_contact_id": 123,
"duplicate_of_id": 123,
"approval_required": true,
"sign_off_required": true,
"owner_portal_enabled": true,
"classification_editable": true,
"approval_requested_at": "<string>",
"classification_options": [
{
"id": "<string>",
"types": [
{
"id": "<string>",
"approval_threshold": 123,
"classification": {
"required": [
"<string>"
],
"optional": [
"<string>"
]
},
"termination_canons": {},
"resolution_business_days": 123
}
]
}
],
"created_at": "<string>",
"updated_at": "<string>",
"labels": [
"<string>"
],
"classification_tenancies": [
{
"id": 123,
"status": "<string>",
"label": "<string>",
"contract_end_date": "<string>",
"canon": "<string>",
"cycles": [
{
"id": 123,
"period_start_on": "<string>",
"amount_due": "<string>",
"status": "<string>"
}
]
}
]
}{
"description": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
]
}{}{}Path Parameters
Response
Success
Per-type terms decided at triage beyond responsible_party and cost_estimate (custom_attributes.classification). Keys vary by type — e.g. payment_reason, property_tenancy_id, billing_cycle_id, termination_cause, delivery_date, termination_amount, document_kind, complaint_target, complaint_merit, complaint_response.