🎉  Watch our webinar with Autodesk on ERP Sync →

Success

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

  • Get Projects
  • Get RFIs
  • Get Drawings
  • Get Service Jobs
  • Get Invoices
  • Get Files
  • More...
Request
curl https://api.agaveapi.com/projects \
    -H 'Api-Version: 2021-11-21' \
    -H 'Client-Id: your_client_id' \
    -H 'Client-Secret: your_client_secret' \
    -H 'Account-Token: any_account_token'

Response
200 OK
[
	{
		"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": "The United States of America"
		},
		"amount": 500000,
		"completion_date": "2022-01-01",
		"description": "2093 Philadelphia Pike residential building",
		"logo_url": "https://storage.agaveapi.com/project-log.png?signature=xxx",
		"name": "Test Project-1",
		"number": "A123",
		"start_date": "2022-01-01",
		"status": "Active",
		"type": "Residential",
		"source_create_time": "2022-01-01T00:00:00Z",
		"source_update_time": "2022-01-01T00:00:00Z"
	}
]
Request
curl https://api.agaveapi.com/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_account_token'

Response
200 OK
[
	{
		id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
		"source_id": "12345",
		"assignee_ids": [
			"ee9b53e7-f982-4be6-bc12-75f716d3ee94"
		],
		"attachments": [
			{}
		],
		"cost_impact": "100.00",
		"creator_id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
		"due_date": "2022-01-01",
		"number": "A-123",
		"question": "Where should we put the electrical socket?",
		"responses": [
			{}
		],
		"specification_section_id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
		"status": "Open",
		"subject": "Electrical Socket",
		"source_create_time": "2022-01-01T00:00:00Z",
		"source_update_time": "2022-01-01T00:00:00Z"
	}
]
Request
curl https://api.agaveapi.com/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_account_token'

Response
200 OK
[
	{
		"id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
		"source_id": "12345",
		"creator_id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
		"discipline": "Architectural",
		"drawing_version_id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
		"filename": "Test_File.pdf",
		"name": "Architectural 2nd Floor Drawing",
		"number": "A123",
		"preview_url": "https://storage.agaveapi.com/preview/file.pdf?signature=xxx&expires_at=20220101T000001Z",
		"revision": "Revision A",
		"url": "https://storage.agaveapi.com/download/file.pdf?signature=xxx&expires_at=20220530T031901Z",
		"version": "5",
		"source_create_time": "2022-01-01T00:00:00Z",
		"source_update_time": "2022-01-01T00:00:00Z"
	}
]
Request
curl https://api.agaveapi.com/jobs \
    -H 'Api-Version: 2021-11-21' \
    -H 'Client-Id: your_client_id' \
    -H 'Client-Secret: your_client_secret' \
    -H 'Account-Token: any_account_token'

Response
200 OK
[
	{
		"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": "The United States of America"
		},
			"completed_time": "2022-01-01T00:00:00Z",
			"customer_id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
			"description": "HVAC repair for AnyCompany Inc.",
			"name": "HVAC repair",
			"status": "Completed",
			"source_create_time": "2022-01-01T00:00:00Z",
			"source_update_time": "2022-01-01T00:00:00Z"
	}
]
Request
curl https://api.agaveapi.com/invoices \
    -H 'Api-Version: 2021-11-21' \
    -H 'Client-Id: your_client_id' \
    -H 'Client-Secret: your_client_secret' \
    -H 'Account-Token: any_account_token'

Response
200 OK
[
	{
		"id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
		"source_id": 12345,
		"amount": 318.6,
		"amount_due": 318.6,
		"currency_code": "USD",
		"customer_id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
		"due_date": "2022-01-01",
		"ar_payment_ids": [
			"ee9b53e7-f982-4be6-bc12-75f716d3ee94"
		],
		"issue_date": "2022-01-01",
		"line_items": [
			{
				"id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
				"source_id": "12345",
				"amount": 100,
				"description": "Two tons of cement.",
				"item_id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
				"quantity": 2,
				"type": "SalesItemLineDetail",
				"unit_price": 50,
				"source_create_time": "2022-01-01T00:00:00Z",
				"source_update_time": "2022-01-01T00:00:00Z"
			}
		],
		"number": "A123",
		"status": "Open",
		"subtotal_amount": 295,
		"tax_amount": 23.6,
		"source_create_time": "2022-01-01T00:00:00Z",
		"source_update_time": "2022-01-01T00:00:00Z"
	}
]
Request
curl https://api.agaveapi.com/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_account_token'

Response
200 OK
[
	{
		"id": "string",
		"source_id": "12345",
		"creator_id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
		"file_version_id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
		"filename": "Test_File.pdf",
		"folder_id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
		"name": "Test_File",
		"notes": [
			"This File is confidential."
		],
		"preview_url": "https://storage.agaveapi.com/preview/file.pdf?signature=xxx&expires_at=20220101T000001Z",
		"size": 98765,
		"type": "Adobe Acrobat PDF",
		"url": "https://storage.agaveapi.com/download/file.pdf?signature=xxx&expires_at=20220530T031901Z",
		"version": "4",
		"source_create_time": "2022-01-01T00:00:00Z",
		"source_update_time": "2022-01-01T00:00:00Z"
	}
]

How Does Agave Work?

Link Account

Agave gives you a customizable, front-end component that allows your users to authenticate read and write access to other systsems of record.

Exchange Token Flow

Agave returns a temporary access token to make sure the authorization process is fully-encrypted.

Privacy

Agave handles your and your users' data in a way that meets industry-leading standards for security and privacy.

Get Started

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

Get Access