Success

After a successful account linking, Agave will return the fetched data from the providers.

  • Get Construction Projects
  • Get RFIs
  • Get Drawings
  • Get Field Service Jobs
  • Get Invoice Payments
  • Get Storage Files
  • More...
Request
curl https://api.agaveapi.com/construction/projects \
    -H 'Api-Version: 2021-11-21' \
    -H 'Client-Id: your_client_id' \
    -H 'Client-Secret: your_client_secret' \
    -H 'Account-Token: any_of_the_account_tokens'
}

Response
200 OK
[
	{
		"id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
		"source_id": "12345",
		"name": "Long Bridge",
		"number": "725 Phase 1",
		"address": {
			"street_1": "1000 Cedar Street",
			"street_2": "Unit 13",
			"city": "Santa Barbara",
			"state": "CA",
			"postal_code": "93103",
			"country": "US"
		},
		"type": "Residential",
		"status": "Active",
		"start_date": "2018-10-19",
		"completion_date": "2018-10-19"
	}
]
Request
curl https://api.agaveapi.com/construction/projects/{project_id}/rfis \
    -H 'Api-Version: 2021-11-21' \
    -H 'Client-Id: your_client_id' \
    -H 'Client-Secret: your_client_secret' \
    -H 'Account-Token: any_of_the_account_tokens'
}

Response
200 OK
[
	{
		"id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
		"source_id": "12345",
		"assignee": {
			"id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
			"source_id": "12345",
			"full_name": "Jane Doe",
			"first_name": "Jane",
			"last_name": "Doe",
			"company": {...},
			"email": "jane@example.com",
			"industry": "Commercial construction",
			"phone": "(123) 555-1230",
			"job_title": "Project Manager"
		},
		"cost_impact": "100.00",
		"created_by": {
			"id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
			"source_id": "12345",
			"full_name": "Jane Doe",
			"first_name": "Jane",
			"last_name": "Doe",
			"company": {...},
			"email": "jane@example.com",
			"industry": "Commercial construction",
			"phone": "(123) 555-1230",
			"job_title": "Project Manager"
		},
		"due_date": "2018-10-19",
		"number": "C-444",
		"project_id": {
			"id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
			"source_id": "12345",
			"name": "Long Bridge",
			"number": "725 Phase 1",
			"address": {...},
			"type": "Residential",
			"status": "Active",
			"start_date": "2018-10-19",
			"completion_date": "2018-10-19"
		},
		"question": "Where should we put the electrical socket?",
		"question_attachment": {
			"id": 12345,
			"url": "www.agaveapi.com/",
			"title": "RFI - lightbulb is not in right place",
			"file_name": "Agave_API_Docs.pdf",
			"version": 3,
			"source_create_time": "2018-10-19T16:46:45Z",
			"source_update_time": "2018-10-19T16:46:45Z"
		},
		"response": "Where should we put the electrical socket?",
		"response_attachment": {
			"id": 12345,
			"url": "www.agaveapi.com/",
			"title": "RFI - lightbulb is not in right place",
			"file_name": "Agave_API_Docs.pdf",
			"version": 3,
			"source_create_time": "2018-10-19T16:46:45Z",
			"source_update_time": "2018-10-19T16:46:45Z"
		},
		"status": "Open",
		"subject": "Electrical",
		"source_create_time": "2018-10-19T16:46:45Z",
		"source_update_time": "2018-10-19T16:46:45Z"
	}
]
Request
curl https://api.agaveapi.com/construction/projects/{project_id}/drawings \
    -H 'Api-Version: 2021-11-21' \
    -H 'Client-Id: your_client_id' \
    -H 'Client-Secret: your_client_secret' \
    -H 'Account-Token: any_of_the_account_tokens'
}

Response
200 OK
[
	{
		"id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
		"source_id": "12345",
		"created_by": {
			"id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
			"source_id": "12345",
			"full_name": "Jane Doe",
			"first_name": "Jane",
			"last_name": "Doe",
			"company": {...},
			"email": "jane@example.com",
			"industry": "Commercial construction",
			"phone": "(123) 555-1230",
			"job_title": "Project Manager"
		},
		"discipline": "Architectural",
		"drawing_version_id": 123,
		"filename": "example.pdf",
		"name": "Third Floor Sheet",
		"number": "C-005",
		"project_id": {
			"id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
			"source_id": "12345",
			"name": "Long Bridge",
			"number": "725 Phase 1",
			"address": {...},
			"type": "Residential",
			"status": "Active",
			"start_date": "2018-10-19",
			"completion_date": "2018-10-19"
		},
		"version_number": 5,
		"source_update_time": "2018-10-19T16:46:45Z"
	}
]
Request
curl https://api.agaveapi.com/field-service/jobs \
    -H 'Api-Version: 2021-11-21' \
    -H 'Client-Id: your_client_id' \
    -H 'Client-Secret: your_client_secret' \
    -H 'Account-Token: any_of_the_account_tokens'
}

Response
200 OK
[
	{
		"id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
		"source_id": "12345",
		"address": {
			"street_1": "1000 Cedar Street",
			"street_2": "Unit 13",
			"city": "Santa Barbara",
			"state": "CA",
			"postal_code": "93103",
			"country": "US"
		},
		"completed_time": "2018-10-19T16:46:45Z",
		"customer": {
			"id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
			"source_id": "12345",
			"full_name": "Jane Doe",
			"first_name": "Jane",
			"last_name": "Doe",
			"company": {...},
			"email": "jane@example.com",
			"industry": "Commercial construction",
			"phone": "(123) 555-1230",
			"job_title": "Project Manager"
		},
		"description": "HVAC repair for AnyCompany Inc.",
		"name": "HVAC repair",
		"status": "Cancelled",
		"source_create_time": "2018-10-19T16:46:45Z",
		"source_update_time": "2018-10-19T16:46:45Z"
	}
]
Request
curl https://api.agaveapi.com/accounting/invoice-payments \
    -H 'Api-Version: 2021-11-21' \
    -H 'Client-Id: your_client_id' \
    -H 'Client-Secret: your_client_secret' \
    -H 'Account-Token: any_of_the_account_tokens'
}

Response
200 OK
[
	{
		"id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
		"source_id": "12345",
		"account": {
			"id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
			"source_id": "12345",
			"name": "Accounts Payable (A/P)",
			"description": "AP account for Agave Tech Inc.",
			"classification": "Liability",
			"code": "123",
			"currency_code": "USD",
			"current_balance": 1602.67,
			"status": "Active",
			"type": "Accounts Payable"
		},
		"currency_code": "USD",
		"customer": {
			"id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
			"source_id": "12345",
			"name": "Jane's Landscaping",
			"addresses": [],
			"currency_code": "USD",
			"email": "jane@example.com",
			"phone": "(123) 555-1230",
			"website": "example.com",
			"status": "Active"
		},
		"line_items": [
			{...}
		],
		"memo": "Partial payment for July invoice.",
		"number": "25",
		"project_id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
		"total_amount": "130.12",
		"transaction_date": "2018-10-19",
		"source_create_time": "2018-10-19T16:46:45Z"
	}
]
Request
curl https://api.agaveapi.com/storage/folders/{folder_id}/files \
    -H 'Api-Version: 2021-11-21' \
    -H 'Client-Id: your_client_id' \
    -H 'Client-Secret: your_client_secret' \
    -H 'Account-Token: any_of_the_account_tokens'
}

Response
200 OK
[
	{
		"id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
		"source_id": "12345",
		"name": "Third Floor Sheet",
		"creator_id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
		"folder_id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
		"size": "2 MB",
		"type": "PDF",
		"url": "https://s3.amazonaws.com/agave-api/d65e88efc5f55fc80efb9.pdf?signature=9ad8873e3314255dc479",
		"source_create_time": "2018-10-19T16:46:45Z",
		"source_update_time": "2018-10-19T16:46:45Z"
	}
]

How Does Agave Work?

Link Account

Agave gives you a pre-built widget that takes you through a streamlined onboarding process for all of the underlying platforms.

Exchange Token Flow

Agave features a temporary access token to make sure the authorisation process is fully-encrypted.

Privacy

You and your users' privacy are our top priority. Agave ensures the security of all the data transations.

Get Started

Reach out and request access now. We will be in touch in 24 hours.