Skip to main content

Source Data

Most Agave API endpoints allow you to fetch the raw data from the Source System by setting the Include-Source-Data header to true. This approach is ideal for when you need access to fields specific to a Source System that are not included in Agave API’s unified model.

If you would like to use endpoints in a Source System that aren't yet supported by Agave API, you create an Authenticated Pass-through Request instead.

Here is example source_data returned from Procore for the Get Construction Project endpoint:

Example Request:

curl https://api.agaveapi.com/construction/projects/ee9b53e7-f982-4be6-bc12-75f716d3ee94 \
--header 'API-Version: 2021-11-21' \
--header 'Client-Id: CLIENT_ID' \
--header 'Client-Secret: CLIENT_SECRET' \
--header 'Account-Token: ACCOUNT_TOKEN'
--header 'Include-Source-Data: true'

Example Response:

  {
"id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
"source_id": "12345",
"address": {
"street_1": "123 Main Street",
"street_2": "Unit 1",
"city": "AnyTown",
"state": "California",
"postal_code": "19703",
"country": "US"
},
"amount": 500000,
"completion_date": "2022-01-01",
"name": "Test Project-1",
"number": "A123",
"start_date": "2022-01-01",
"status": "Active",
"type": "Residential",
"source_data": {
"id": 12345,
"name": "Test Project-1",
"is_demo": false,
"parent_job_id": null,
"display_name": "Test Project 1",
"project_number": "A123",
"address": "123 Main Street, Unit 1",
"city": "AnyTown",
"state_code": "DE",
"country_code": "US",
"zip": "19703",
"county": "New Castle County",
"time_zone": "Pacific Time (US & Canada)",
"latitude": null,
"longitude": null,
"stage": "None",
"phone": "(123) 555-0100",
"created_at": "2022-01-01T00:00:00Z",
"updated_at": "2022-01-01T00:00:00Z",
"active": true,
"origin_id": null,
"origin_data": null,
"origin_code": null,
"owners_project_id": null,
"estimated_value": "500000.0",
"project_region_id": null,
"project_bid_type_id": null,
"project_owner_type_id": null,
"photo_id": null,
"start_date": "2022-01-01",
"completion_date": "2023-01-01",
"total_value": "500000.0",
"accounting_project_number": null,
"store_number": null,
"designated_market_area": null,
"custom_fields": [ ],
"company": {
"id": 12345,
"name": "AnyCompany"
}
}
}