Agave Unified API (2021-11-21)
Here, you can find a complete list of our APIs. For more general information about how to use them, please refer to our guides.
These endpoints let you generate a Link Token and exchange a temporary Public Token with a permanent Account Token. To learn more, see Authentication Flow.
Create Link Token
This endpoint allows you to generate a new link token and use that to initialize the Agave Link frontend component. To learn more, see Link Component.
Authorizations:
header Parameters
API-Version required | string This value specifies which Agave API version to use.
The current version is |
Request Body schema: application/json
reference_id required | string A unique identifier for the User in your app. To learn more, see Reference ID. |
Responses
Request samples
- Payload
{- "reference_id": "user-123456"
}
Response samples
- 200
- 400
{- "link_token": "ttq2FdbUe6_dMGe2fVAQwSl1o0G8_4wBac..."
}
Exchange Link Token
This endpoint allows you to exchange a short-lived public_token
for a permanent account_token
. You can use this account_token
to make requests on behalf of a user indefinitely.
Authorizations:
header Parameters
API-Version required | string This value specifies which Agave API version to use.
The current version is |
Request Body schema: application/json
public_token required | string The public token returned by the Agave Link component. |
Responses
Request samples
- Payload
{- "public_token": "e62FtdAQwSl1e2fb_dMG8_4wBtqUVo0Gac..."
}
Response samples
- 200
- 400
{- "account_token": "rxdBse2l1fb_dMw4UtwQBm62G8_GV0acqo...",
- "account_id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
- "connection": {
- "type": "api_token",
- "properties": { }
}, - "linked_company": {
- "id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
- "source_id": "12345",
- "name": "Agave construction Inc."
}, - "linked_user": {
- "id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
- "source_id": "12345",
- "name": "John Smith",
- "email": "jsmith@example.com"
}, - "status": "linked",
- "source_system": {
- "slug": "procore",
- "name": "Procore"
}, - "supports_cross_account_uuid": true
}
These endpoints let you generate a temporary, limited-in-scope session to be used in your front-end single-page application. To learn more, see Link Session.
Create Link Session
You can generate a Link Session with either a "mode" (e.g. 'file-picker'
) or a list of scopes (e.g. ['link:read', 'projects:read', 'projects:write']
).
When possible, we recommend passing a "mode" to ensures maximum compatibility with future Agave API changes.
Authorizations:
header Parameters
API-Version required | string This value specifies which Agave API version to use.
The current version is |
Request Body schema:
name required | string The name of the Session. |
ttl required | number The duration of the Session (in seconds). |
mode required | string Enum: "file-picker" "file-uploader" A "mode" is a shorthand for a series of individual scopes. For example,
which is the full list of scopes required for the Agave File Manager component to work for a Construction Project. |
Responses
Request samples
- Payload
{- "name": "file manager demo",
- "ttl": 1800,
- "mode": "file-picker"
}
Response samples
- 200
- 400
{- "id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
- "session": "ttq2FdbUe6_dMGe2fVAQwSl1o0G8_4wBac...",
- "scopes": "ttq2FdbUe6_dMGe2fVAQwSl1o0G8_4wBac...",
- "expires_at": "2022-01-01T00:00:00Z"
}
Revoke All Tokens
This endpoint allows you to revoke all tokens generated for this Account. Agave will revoke the Account Token, delete all credentials, and revoke all underlying OAuth access and refresh tokens (if supported for the source system).
🚨 Note: After calling this endpoint, you will never be able to access this account again, as all credentials have been removed from Agave's systems. If you need to link this account in the future, you must instruct your users to re-authenticate via Agave Link.
Authorizations:
header Parameters
API-Version required | string This value specifies which Agave API version to use.
The current version is |
Responses
Response samples
- 200
- 400
{- "success": true,
- "tokens_revoked": 1
}
These endpoints let you inspect the Linked Account, Linked Company, and Linked Source Systems.
Linked Account
This endpoint allows you to retrieve the Linked Account associated with an account_token
.
The email address returned from the Linked User endpoint can be used to map to content stored in your application to this Linked Account.
Authorizations:
header Parameters
API-Version required | string This value specifies which Agave API version to use.
The current version is |
Include-Source-Data | boolean Default: false A flag denoting whether you would like to also return the raw data from a Source System. |
Responses
Response samples
- 200
- 400
{- "account_id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
- "connection": {
- "type": "api_token",
- "properties": { }
}, - "linked_company": {
- "id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
- "source_id": "12345",
- "name": "Agave construction Inc."
}, - "linked_user": {
- "id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
- "source_id": "12345",
- "name": "John Smith",
- "email": "jsmith@example.com"
}, - "status": "linked",
- "source_system": {
- "slug": "procore",
- "name": "Procore"
}, - "supports_cross_account_uuid": true
}
Linked Company
Get the company information associated with the provided account token.
Note that in some integrations (such as Procore), an end user could belong to multiple companies. In such cases, each connected company is a separate linked account.
Authorizations:
header Parameters
API-Version required | string This value specifies which Agave API version to use.
The current version is |
Include-Source-Data | boolean Default: false A flag denoting whether you would like to also return the raw data from a Source System. |
Responses
Response samples
- 200
- 400
- 429
{- "id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
- "source_id": "12345",
- "name": "Agave construction Inc.",
- "offices": [
- {
- "id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
- "source_id": "12345",
- "address": {
- "street_1": "123 Main Street",
- "street_2": "Unit 1",
- "city": "AnyTown",
- "state": "California",
- "country": "The United States of America",
- "postal_code": "19703"
}, - "phone": "8004444444",
- "fax": "8004444444"
}
]
}
Linked Connection
This endpoint allows you to retrieve properties associated with each Connection (e.g. oauth2, basic auth)
associated with an account_token
.
The properties returned from the Linked User endpoint can be used to map to content stored in your application to this Connection.
Authorizations:
header Parameters
API-Version required | string This value specifies which Agave API version to use.
The current version is |
Include-Source-Data | boolean Default: false A flag denoting whether you would like to also return the raw data from a Source System. |
Responses
Response samples
- 200
- 400
{- "type": "api_token",
- "properties": { }
}
Linked User
This endpoint allows you to retrieve information on a Linked User associated with an account_token
.
Authorizations:
header Parameters
API-Version required | string This value specifies which Agave API version to use.
The current version is |
Include-Source-Data | boolean Default: false A flag denoting whether you would like to also return the raw data from a Source System. |
Responses
Response samples
- 200
- 400
- 429
{- "id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
- "source_id": "12345",
- "name": "John Smith",
- "email": "jsmith@example.com"
}
Linked Source System
This endpoint gives you a list of features supported by the Linked Source System. It also returns components (e.g. image, theme color) that you can use to customize your application's interface.
Authorizations:
header Parameters
API-Version required | string This value specifies which Agave API version to use.
The current version is |
Responses
Response samples
- 200
- 400
{- "id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
- "slug": "procore",
- "name": "Procore",
- "category": "construction",
- "cross_account_uuid_available": true,
- "file_upload_gb_size_limit": 5,
- "passthrough_available": true,
- "sandbox_environment_available": true,
- "theme": {
- "color": "#FF5200",
}
}
Available Source Systems
This endpoint returns a list of features supported by the Source Systems available to your user, as well as components (e.g. image, theme color) that you can use to customize your application's interface.
Authorizations:
header Parameters
API-Version required | string This value specifies which Agave API version to use.
The current version is |
Responses
Response samples
- 200
- 400
[- {
- "id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
- "slug": "procore",
- "name": "Procore",
- "category": "construction",
- "cross_account_uuid_available": true,
- "file_upload_gb_size_limit": 5,
- "passthrough_available": true,
- "sandbox_environment_available": true,
- "theme": {
- "color": "#FF5200",
}
}
]
Rate Limits
This endpoint returns information about Rate Limits for a Linked Source System, including the interval, rate limit per interval, and number of requests you have remaining before hitting the rate limit in the current interval.
To see a list of published Rate Limits for Source Systems that Agave supports, see link.
Currently supported for:
- Aconex
- BIM Track
- CompanyCam
- Egnyte
- Fieldwire
- PlanGrid
- Procore
- Salesforce
- ServiceTitan
Authorizations:
header Parameters
API-Version required | string This value specifies which Agave API version to use.
The current version is |
Include-Source-Data | boolean Default: false A flag denoting whether you would like to also return the raw data from a Source System. |
Responses
Response samples
- 200
- 400
- 429
{- "interval": "concurrent",
- "limit": 10,
- "remaining": 3
}
This model returns information about Available Source Systems.
id | string <uuid> The UUID of the Source System assigned by Agave |
slug | string The Source System's short identifier. |
name | string The Source System's user-facing name. |
category | string Enum: "accounting" "construction" "field-service" The Source System's category. |
cross_account_uuid_available | boolean If true, UUIDs for resources in this source system are persistent across accounts. For example, if you have two users (user_1 and user_2) both linking their accounts to the same Procore company, the UUIDs returned for the same project will be identical. |
file_upload_gb_size_limit | number This field specifies the maximum file size supported by this Source System for file uploads. |
passthrough_available | boolean This field specifies whether this Source System supports passthrough requests, which let you make custom API requests to this Source System on behalf of your user. |
sandbox_environment_available | boolean This field specifies whether this Source System supports a sandbox environment. |
object The Source System's theme color and image. You can use these fields to customize your application's UI. |
{- "id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
- "slug": "procore",
- "name": "Procore",
- "category": "construction",
- "cross_account_uuid_available": true,
- "file_upload_gb_size_limit": 5,
- "passthrough_available": true,
- "sandbox_environment_available": true,
- "theme": {
- "color": "#FF5200",
}
}
This model returns information about Linked Account's Status, Source System, Company, Rate Limits, and User.
account_id | string <uuid> The Agave-generated UUID of the Account. |
object This field includes properties associated with each Connection (e.g. oauth2, basic auth) associated with an | |
object Information about the Linked Company. | |
object Information about the user who initiated the link. | |
status | string Enum: "pending" "linked" "unlinked" "invalid" The status of the Linked Account.
|
object Information about the linked Source System. | |
supports_cross_account_uuid | boolean If true, UUIDs for resources in this account are persistent across accounts. For example, if you have two users (user_1 and user_2) both linking their accounts to the same Procore company, the UUIDs returned for the same project will be identical. |
{- "account_id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
- "connection": {
- "type": "api_token",
- "properties": { }
}, - "linked_company": {
- "id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
- "source_id": "12345",
- "name": "Agave construction Inc."
}, - "linked_user": {
- "id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
- "source_id": "12345",
- "name": "John Smith",
- "email": "jsmith@example.com"
}, - "status": "linked",
- "source_system": {
- "slug": "procore",
- "name": "Procore"
}, - "supports_cross_account_uuid": true
}
This model returns information about a Linked Company.
id | string <uuid> The UUID of the Company assigned by Agave. |
source_id | string The ID of the Company in the Source System. |
name | string The name of the Company. |
Array of objects (Office) |
{- "id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
- "source_id": "12345",
- "name": "Agave construction Inc.",
- "offices": [
- {
- "id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
- "source_id": "12345",
- "address": {
- "street_1": "123 Main Street",
- "street_2": "Unit 1",
- "city": "AnyTown",
- "state": "California",
- "country": "The United States of America",
- "postal_code": "19703"
}, - "phone": "8004444444",
- "fax": "8004444444"
}
]
}
This model returns information about a Connection, it's type (e.g. OAuth2), and associated properties.
type | string Enum: "api_token" "basic_auth" "oauth2" The type of Connection (e.g. oauth2). |
properties | object The properties of the Connection. Note, the fields in this object will differ by Connection type and Source System. |
{- "type": "api_token",
- "properties": { }
}
This model returns information about Linked Source Systems.
id | string <uuid> The UUID of the Source System assigned by Agave |
slug | string The Source System's short identifier. |
name | string The Source System's user-facing name. |
category | string Enum: "accounting" "construction" "field-service" The Source System's category. |
cross_account_uuid_available | boolean If true, UUIDs for resources in this source system are persistent across accounts. For example, if you have two users (user_1 and user_2) both linking their accounts to the same Procore company, the UUIDs returned for the same project will be identical. |
file_upload_gb_size_limit | number This field specifies the maximum file size supported by this Source System for file uploads. |
passthrough_available | boolean This field specifies whether this Source System supports passthrough requests, which let you make custom API requests to this Source System on behalf of your user. |
sandbox_environment_available | boolean This field specifies whether this Source System supports a sandbox environment. |
object The Source System's theme color and image. You can use these fields to customize your application's UI. |
{- "id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
- "slug": "procore",
- "name": "Procore",
- "category": "construction",
- "cross_account_uuid_available": true,
- "file_upload_gb_size_limit": 5,
- "passthrough_available": true,
- "sandbox_environment_available": true,
- "theme": {
- "color": "#FF5200",
}
}
This model returns information about a Linked User.
id | string <uuid> The UUID of the Linked User assigned by Agave. |
source_id | string The ID of the Linked User from the Source System. |
name | string The Linked User's name |
string The Linked User's email address |
{- "id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
- "source_id": "12345",
- "name": "John Smith",
- "email": "jsmith@example.com"
}
This model returns information about Rate Limits for a Linked Source System.
interval | string Enum: "concurrent" "per_day" "per_hour" "per_minute" "per_month" "per_second" "per_week" The timeframe for a rate limit. |
limit | integer The number of requests that can be made per interval. |
remaining | integer The number of remaining requests that can be made per an interval. |
{- "interval": "concurrent",
- "limit": 10,
- "remaining": 3
}
The below are endpoints you can use to retrieve info about activity for your Client ID and Client Secret (e.g. authenticated accounts).
Admin Accounts
This endpoint allows you to retrieve a list of Linked Accounts that authenticated with Agave using your Client Id and Client Secret.
Authorizations:
header Parameters
API-Version required | string This value specifies which Agave API version to use.
The current version is |
Responses
Response samples
- 200
- 400
[- {
- "account_id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
- "created_at": "2022-01-01T00:00:00Z",
- "linked_company": {
- "id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
- "source_id": "12345",
- "name": "Agave construction Inc."
}, - "linked_user": {
- "id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
- "source_id": "12345",
- "name": "John Smith",
- "email": "jsmith@example.com"
}, - "reference_id": "user-123456",
- "source_system": {
- "slug": "procore",
- "name": "Procore"
}, - "source_system_environment": {
- "slug": "prod",
- "name": "Prod"
}, - "status": "linked",
- "supports_cross_account_uuid": true
}
]
This endpoint lets you make authenticated pass-through JSON requests to the source system. For more information, see Pass-through Requests: JSON.
Pass-through (JSON)
Authorizations:
header Parameters
API-Version required | string This value specifies which Agave API version to use.
The current version is |
Request Body schema: application/json
method required | string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" The method for the request to the source system |
path required | string The path for the request to the source system |
data | object The data for the request body |
Responses
Request samples
- Payload
{- "method": "GET",
- "path": "/rest/v1.0/me",
- "data": {
- "company_id": 31936
}
}
Response samples
- 200
- 400
{- "status": 200,
- "content_type": "application/json; charset=utf-8",
- "body": {
- "id": 77742,
- "login": "procore-test-user@agaveapi.com",
- "name": "Procore Test User"
}, - "headers": {
- "Cache-Control": [
- "no-store, no-cache, must-revalidate",
- "no-cache=\"set-cookie\""
], - "Content-Type": [
- "application/json; charset=utf-8"
], - "ETag": [
- "W/\"fe2ae8facdecf9e5fe07a3aa9729a082\""
], - "Referrer-Policy": [
- "strict-origin-when-cross-origin"
], - "Status": [
- "200 OK"
], - "Strict-Transport-Security": [
- "max-age=31536000; includeSubDomains"
], - "Vary": [
- "Accept-Encoding"
]
}
}
This endpoint lets you make authenticated pass-through multipart requests to the source system (such as uploading a file). For more information, see Pass-through Requests: Multipart.
Pass-through (Multipart)
⚠️ Note: You must use the multipart/form-data
Content-Type when making the request.
The Content-Type is used to specify the media type of the resource.
Authorizations:
header Parameters
API-Version required | string This value specifies which Agave API version to use.
The current version is |
Passthrough-Method required | string Example: POST The method for the request to the source system. |
Passthrough-Path required | string Example: rest/v1.0/images?project_id=66738 The path for the request to the source system with query parameters |
Request Body schema: multipart/form-data
varies_by_endpoint | object For examples, see Pass-through Requests: Multipart |
Responses
Response samples
- 200
- 400
{- "status": 200,
- "content_type": "application/json; charset=utf-8",
- "body": {
- "id": 1187281,
- "uploader": {
- "id": 77742,
- "login": "procore-test-user@agaveapi.com",
- "name": "Procore Test User"
}, - "filename": "Sample File.png",
- "width": 263,
- "height": 159
}, - "headers": {
- "Cache-Control": [
- "no-store, no-cache, must-revalidate",
- "no-cache=\"set-cookie\""
], - "Content-Type": [
- "application/json; charset=utf-8"
], - "ETag": [
- "W/\"fe2ae8facdecf9e5fe07a3aa9729a082\""
], - "Referrer-Policy": [
- "strict-origin-when-cross-origin"
], - "Status": [
- "200 OK"
], - "Strict-Transport-Security": [
- "max-age=31536000; includeSubDomains"
], - "Vary": [
- "Accept-Encoding"
]
}
}
An Activity is an event on a calendar that can be associated with an opportunity, a contact, and/or a customer.
Supported Source Systems include:
- HubSpot (read and write, only "note" at the moment)
- Pipedrive (read, write, and add attachment)
All Activities
This endpoint retrieves a list of Activities a Linked User can access.
Authorizations:
query Parameters
type | string <string> Type of the Activity, e.g. "note". Required for HubSpot. |
header Parameters
API-Version required | string This value specifies which Agave API version to use.
The current version is |
Include-Source-Data | boolean Default: false A flag denoting whether you would like to also return the raw data from a Source System. |
Responses
Response samples
- 200
- 400
- 429
{- "data": [
- {
- "id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
- "source_id": "12345",
- "activity_time": "2022-01-01T00:00:00Z",
- "attachment_ids": [
- "ee9b53e7-f982-4be6-bc12-75f716d3ee94"
], - "description": "Latest <strong>notes</strong>.",
- "subject": "Check-in on Status",
- "type": "note",
- "source_create_time": "2022-01-01T00:00:00Z",
- "source_update_time": "2022-01-01T00:00:00Z",
- "source_data": {
- "content_type": "application/json",
- "data": {
- "id": "29564829699",
- "properties": {
- "hs_all_accessible_team_ids": null,
- "hs_all_assigned_business_unit_ids": null,
- "hs_all_owner_ids": "269408298",
- "hs_all_team_ids": null,
- "hs_at_mentioned_owner_ids": null,
- "hs_attachment_ids": null,
- "hs_body_preview": "test",
- "hs_body_preview_html": "<html>\n <head></head>\n <body>\n <div style=\"white-space: pre-wrap;\" dir=\"auto\" data-top-level=\"true\"> \n <p style=\"margin-bottom:0;\">test</p> \n </div>\n </body>\n</html>",
- "hs_body_preview_is_truncated": "false",
- "hs_created_by": "48320936",
- "hs_created_by_user_id": "48320936",
- "hs_createdate": "2023-01-05T06:57:42.491Z",
- "hs_engagement_source": "CRM_UI",
- "hs_engagement_source_id": null,
- "hs_follow_up_action": null,
- "hs_gdpr_deleted": null,
- "hs_lastmodifieddate": "2023-01-05T06:57:42.491Z",
- "hs_merged_object_ids": null,
- "hs_modified_by": "48320936",
- "hs_note_body": "<div style=\"white-space: pre-wrap;\" dir=\"auto\" data-top-level=\"true\"><p style=\"margin-bottom:0;\">test</p></div>",
- "hs_object_id": "29564829699",
- "hs_product_name": null,
- "hs_queue_membership_ids": null,
- "hs_read_only": null,
- "hs_timestamp": "2023-01-05T06:57:42.491Z",
- "hs_unique_creation_key": null,
- "hs_unique_id": null,
- "hs_updated_by_user_id": "48320936",
- "hs_user_ids_of_all_notification_followers": null,
- "hs_user_ids_of_all_notification_unfollowers": null,
- "hs_user_ids_of_all_owners": "48320936",
- "hubspot_owner_assigneddate": "2023-01-05T06:57:42.491Z",
- "hubspot_owner_id": "269408298",
- "hubspot_team_id": null
}, - "createdAt": "2023-01-05T06:57:42.491Z",
- "updatedAt": "2023-01-05T06:57:42.491Z",
- "archived": false
}
}
}
], - "meta": {
- "current_page": 1,
- "has_more_results": true
}
}
Activity
This endpoint creates Activities.
Authorizations:
header Parameters
API-Version required | string This value specifies which Agave API version to use.
The current version is |
Include-Source-Data | boolean Default: false A flag denoting whether you would like to also return the raw data from a Source System. |
Request Body schema:
activity_time | string <date-time> The datetime for the Activity. |
description | string The description of the Activity. Supporting HTML markup. |
type | string The type of the Activity. |
source_data | object |
Responses
Request samples
- Payload
{- "activity_time": "2022-01-01T00:00:00Z",
- "description": "Latest <strong>notes</strong>.",
- "type": "note",
- "source_data": {
- "properties": {
- "hs_attachment_ids": "{{source_attachment_id}}"
}
}
}
Response samples
- 200
- 400
- 429
{- "id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
- "source_id": "12345",
- "activity_time": "2022-01-01T00:00:00Z",
- "attachment_ids": [
- "ee9b53e7-f982-4be6-bc12-75f716d3ee94"
], - "description": "Latest <strong>notes</strong>.",
- "subject": "Check-in on Status",
- "type": "note",
- "source_create_time": "2022-01-01T00:00:00Z",
- "source_update_time": "2022-01-01T00:00:00Z",
- "source_data": {
- "content_type": "application/json",
- "data": {
- "id": "29564829699",
- "properties": {
- "hs_all_accessible_team_ids": null,
- "hs_all_assigned_business_unit_ids": null,
- "hs_all_owner_ids": "269408298",
- "hs_all_team_ids": null,
- "hs_at_mentioned_owner_ids": null,
- "hs_attachment_ids": null,
- "hs_body_preview": "test",
- "hs_body_preview_html": "<html>\n <head></head>\n <body>\n <div style=\"white-space: pre-wrap;\" dir=\"auto\" data-top-level=\"true\"> \n <p style=\"margin-bottom:0;\">test</p> \n </div>\n </body>\n</html>",
- "hs_body_preview_is_truncated": "false",
- "hs_created_by": "48320936",
- "hs_created_by_user_id": "48320936",
- "hs_createdate": "2023-01-05T06:57:42.491Z",
- "hs_engagement_source": "CRM_UI",
- "hs_engagement_source_id": null,
- "hs_follow_up_action": null,
- "hs_gdpr_deleted": null,
- "hs_lastmodifieddate": "2023-01-05T06:57:42.491Z",
- "hs_merged_object_ids": null,
- "hs_modified_by": "48320936",
- "hs_note_body": "<div style=\"white-space: pre-wrap;\" dir=\"auto\" data-top-level=\"true\"><p style=\"margin-bottom:0;\">test</p></div>",
- "hs_object_id": "29564829699",
- "hs_product_name": null,
- "hs_queue_membership_ids": null,
- "hs_read_only": null,
- "hs_timestamp": "2023-01-05T06:57:42.491Z",
- "hs_unique_creation_key": null,
- "hs_unique_id": null,
- "hs_updated_by_user_id": "48320936",
- "hs_user_ids_of_all_notification_followers": null,
- "hs_user_ids_of_all_notification_unfollowers": null,
- "hs_user_ids_of_all_owners": "48320936",
- "hubspot_owner_assigneddate": "2023-01-05T06:57:42.491Z",
- "hubspot_owner_id": "269408298",
- "hubspot_team_id": null
}, - "createdAt": "2023-01-05T06:57:42.491Z",
- "updatedAt": "2023-01-05T06:57:42.491Z",
- "archived": false
}
}
}
One Activity
This endpoint retrieves an Activity by its Agave UUID.
Authorizations:
path Parameters
id required | string <uuid> The UUID of the Activity assigned by Agave. |
header Parameters
API-Version required | string This value specifies which Agave API version to use.
The current version is |
Include-Source-Data | boolean Default: false A flag denoting whether you would like to also return the raw data from a Source System. |
Responses
Response samples
- 200
- 429
{- "id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
- "source_id": "12345",
- "activity_time": "2022-01-01T00:00:00Z",
- "attachment_ids": [
- "ee9b53e7-f982-4be6-bc12-75f716d3ee94"
], - "description": "Latest <strong>notes</strong>.",
- "subject": "Check-in on Status",
- "type": "note",
- "source_create_time": "2022-01-01T00:00:00Z",
- "source_update_time": "2022-01-01T00:00:00Z",
- "source_data": {
- "content_type": "application/json",
- "data": {
- "id": "29564829699",
- "properties": {
- "hs_all_accessible_team_ids": null,
- "hs_all_assigned_business_unit_ids": null,
- "hs_all_owner_ids": "269408298",
- "hs_all_team_ids": null,
- "hs_at_mentioned_owner_ids": null,
- "hs_attachment_ids": null,
- "hs_body_preview": "test",
- "hs_body_preview_html": "<html>\n <head></head>\n <body>\n <div style=\"white-space: pre-wrap;\" dir=\"auto\" data-top-level=\"true\"> \n <p style=\"margin-bottom:0;\">test</p> \n </div>\n </body>\n</html>",
- "hs_body_preview_is_truncated": "false",
- "hs_created_by": "48320936",
- "hs_created_by_user_id": "48320936",
- "hs_createdate": "2023-01-05T06:57:42.491Z",
- "hs_engagement_source": "CRM_UI",
- "hs_engagement_source_id": null,
- "hs_follow_up_action": null,
- "hs_gdpr_deleted": null,
- "hs_lastmodifieddate": "2023-01-05T06:57:42.491Z",
- "hs_merged_object_ids": null,
- "hs_modified_by": "48320936",
- "hs_note_body": "<div style=\"white-space: pre-wrap;\" dir=\"auto\" data-top-level=\"true\"><p style=\"margin-bottom:0;\">test</p></div>",
- "hs_object_id": "29564829699",
- "hs_product_name": null,
- "hs_queue_membership_ids": null,
- "hs_read_only": null,
- "hs_timestamp": "2023-01-05T06:57:42.491Z",
- "hs_unique_creation_key": null,
- "hs_unique_id": null,
- "hs_updated_by_user_id": "48320936",
- "hs_user_ids_of_all_notification_followers": null,
- "hs_user_ids_of_all_notification_unfollowers": null,
- "hs_user_ids_of_all_owners": "48320936",
- "hubspot_owner_assigneddate": "2023-01-05T06:57:42.491Z",
- "hubspot_owner_id": "269408298",
- "hubspot_team_id": null
}, - "createdAt": "2023-01-05T06:57:42.491Z",
- "updatedAt": "2023-01-05T06:57:42.491Z",
- "archived": false
}
}
}
One Activity
This endpoint updates an Activity by its Agave UUID.
Authorizations:
path Parameters
id required | string <uuid> The UUID of the Activity assigned by Agave. |
header Parameters
API-Version required | string This value specifies which Agave API version to use.
The current version is |
Include-Source-Data | boolean Default: false A flag denoting whether you would like to also return the raw data from a Source System. |
Request Body schema:
activity_time | string <date-time> The datetime for the Activity. |
description | string The description of the Activity. Supporting HTML markup. |
type | string The type of the Activity. |
source_data | object |
Responses
Request samples
- Payload
{- "activity_time": "2022-01-01T00:00:00Z",
- "description": "Latest <strong>notes</strong>.",
- "type": "note",
- "source_data": {
- "properties": {
- "hs_attachment_ids": "{{source_attachment_id}}"
}
}
}
Response samples
- 200
- 429
{- "id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
- "source_id": "12345",
- "activity_time": "2022-01-01T00:00:00Z",
- "attachment_ids": [
- "ee9b53e7-f982-4be6-bc12-75f716d3ee94"
], - "description": "Latest <strong>notes</strong>.",
- "subject": "Check-in on Status",
- "type": "note",
- "source_create_time": "2022-01-01T00:00:00Z",
- "source_update_time": "2022-01-01T00:00:00Z",
- "source_data": {
- "content_type": "application/json",
- "data": {
- "id": "29564829699",
- "properties": {
- "hs_all_accessible_team_ids": null,
- "hs_all_assigned_business_unit_ids": null,
- "hs_all_owner_ids": "269408298",
- "hs_all_team_ids": null,
- "hs_at_mentioned_owner_ids": null,
- "hs_attachment_ids": null,
- "hs_body_preview": "test",
- "hs_body_preview_html": "<html>\n <head></head>\n <body>\n <div style=\"white-space: pre-wrap;\" dir=\"auto\" data-top-level=\"true\"> \n <p style=\"margin-bottom:0;\">test</p> \n </div>\n </body>\n</html>",
- "hs_body_preview_is_truncated": "false",
- "hs_created_by": "48320936",
- "hs_created_by_user_id": "48320936",
- "hs_createdate": "2023-01-05T06:57:42.491Z",
- "hs_engagement_source": "CRM_UI",
- "hs_engagement_source_id": null,
- "hs_follow_up_action": null,
- "hs_gdpr_deleted": null,
- "hs_lastmodifieddate": "2023-01-05T06:57:42.491Z",
- "hs_merged_object_ids": null,
- "hs_modified_by": "48320936",
- "hs_note_body": "<div style=\"white-space: pre-wrap;\" dir=\"auto\" data-top-level=\"true\"><p style=\"margin-bottom:0;\">test</p></div>",
- "hs_object_id": "29564829699",
- "hs_product_name": null,
- "hs_queue_membership_ids": null,
- "hs_read_only": null,
- "hs_timestamp": "2023-01-05T06:57:42.491Z",
- "hs_unique_creation_key": null,
- "hs_unique_id": null,
- "hs_updated_by_user_id": "48320936",
- "hs_user_ids_of_all_notification_followers": null,
- "hs_user_ids_of_all_notification_unfollowers": null,
- "hs_user_ids_of_all_owners": "48320936",
- "hubspot_owner_assigneddate": "2023-01-05T06:57:42.491Z",
- "hubspot_owner_id": "269408298",
- "hubspot_team_id": null
}, - "createdAt": "2023-01-05T06:57:42.491Z",
- "updatedAt": "2023-01-05T06:57:42.491Z",
- "archived": false
}
}
}
One Activity
This endpoint can be used to delete a Activity by its Agave UUID.
Authorizations:
path Parameters
id required | string <uuid> The UUID of the Activity assigned by Agave. |
header Parameters
API-Version required | string This value specifies which Agave API version to use.
The current version is |
Include-Source-Data | boolean Default: false A flag denoting whether you would like to also return the raw data from a Source System. |
Responses
Response samples
- 200
- 429
{- "id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
- "source_id": "12345",
- "activity_time": "2022-01-01T00:00:00Z",
- "attachment_ids": [
- "ee9b53e7-f982-4be6-bc12-75f716d3ee94"
], - "description": "Latest <strong>notes</strong>.",
- "subject": "Check-in on Status",
- "type": "note",
- "source_create_time": "2022-01-01T00:00:00Z",
- "source_update_time": "2022-01-01T00:00:00Z",
- "source_data": {
- "content_type": "application/json",
- "data": {
- "id": "29564829699",
- "properties": {
- "hs_all_accessible_team_ids": null,
- "hs_all_assigned_business_unit_ids": null,
- "hs_all_owner_ids": "269408298",
- "hs_all_team_ids": null,
- "hs_at_mentioned_owner_ids": null,
- "hs_attachment_ids": null,
- "hs_body_preview": "test",
- "hs_body_preview_html": "<html>\n <head></head>\n <body>\n <div style=\"white-space: pre-wrap;\" dir=\"auto\" data-top-level=\"true\"> \n <p style=\"margin-bottom:0;\">test</p> \n </div>\n </body>\n</html>",
- "hs_body_preview_is_truncated": "false",
- "hs_created_by": "48320936",
- "hs_created_by_user_id": "48320936",
- "hs_createdate": "2023-01-05T06:57:42.491Z",
- "hs_engagement_source": "CRM_UI",
- "hs_engagement_source_id": null,
- "hs_follow_up_action": null,
- "hs_gdpr_deleted": null,
- "hs_lastmodifieddate": "2023-01-05T06:57:42.491Z",
- "hs_merged_object_ids": null,
- "hs_modified_by": "48320936",
- "hs_note_body": "<div style=\"white-space: pre-wrap;\" dir=\"auto\" data-top-level=\"true\"><p style=\"margin-bottom:0;\">test</p></div>",
- "hs_object_id": "29564829699",
- "hs_product_name": null,
- "hs_queue_membership_ids": null,
- "hs_read_only": null,
- "hs_timestamp": "2023-01-05T06:57:42.491Z",
- "hs_unique_creation_key": null,
- "hs_unique_id": null,
- "hs_updated_by_user_id": "48320936",
- "hs_user_ids_of_all_notification_followers": null,
- "hs_user_ids_of_all_notification_unfollowers": null,
- "hs_user_ids_of_all_owners": "48320936",
- "hubspot_owner_assigneddate": "2023-01-05T06:57:42.491Z",
- "hubspot_owner_id": "269408298",
- "hubspot_team_id": null
}, - "createdAt": "2023-01-05T06:57:42.491Z",
- "updatedAt": "2023-01-05T06:57:42.491Z",
- "archived": false
}
}
}
Activity Attachment
This endpoint uploads Attachments to an Activity.
Note: In order to upload an Attachment, you must use the multipart/form-data
Content-Type when making the request.
The Content-Type is used to specify the media type of the resource.
Authorizations:
path Parameters
activity_id required | string <uuid> The UUID of the Activity assigned by Agave |
header Parameters
API-Version required | string This value specifies which Agave API version to use.
The current version is |
Include-Source-Data | boolean Default: false A flag denoting whether you would like to also return the raw data from a Source System. |
Request Body schema: multipart/form-data
notes | string Notes of the Attachment. |
content_type | string The MIME type of the uploaded Attachment. |
contents required | string <binary> The binary content of the Attachment, sent as part of the |
name | string The name or title of the Attachment. |
Responses
Response samples
- 200
- 400
- 429
{- "id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
- "source_id": "12345",
- "activity_time": "2022-01-01T00:00:00Z",
- "attachment_ids": [
- "ee9b53e7-f982-4be6-bc12-75f716d3ee94"
], - "description": "Latest <strong>notes</strong>.",
- "subject": "Check-in on Status",
- "type": "note",
- "source_create_time": "2022-01-01T00:00:00Z",
- "source_update_time": "2022-01-01T00:00:00Z",
- "source_data": {
- "content_type": "application/json",
- "data": {
- "id": "29564829699",
- "properties": {
- "hs_all_accessible_team_ids": null,
- "hs_all_assigned_business_unit_ids": null,
- "hs_all_owner_ids": "269408298",
- "hs_all_team_ids": null,
- "hs_at_mentioned_owner_ids": null,
- "hs_attachment_ids": null,
- "hs_body_preview": "test",
- "hs_body_preview_html": "<html>\n <head></head>\n <body>\n <div style=\"white-space: pre-wrap;\" dir=\"auto\" data-top-level=\"true\"> \n <p style=\"margin-bottom:0;\">test</p> \n </div>\n </body>\n</html>",
- "hs_body_preview_is_truncated": "false",
- "hs_created_by": "48320936",
- "hs_created_by_user_id": "48320936",
- "hs_createdate": "2023-01-05T06:57:42.491Z",
- "hs_engagement_source": "CRM_UI",
- "hs_engagement_source_id": null,
- "hs_follow_up_action": null,
- "hs_gdpr_deleted": null,
- "hs_lastmodifieddate": "2023-01-05T06:57:42.491Z",
- "hs_merged_object_ids": null,
- "hs_modified_by": "48320936",
- "hs_note_body": "<div style=\"white-space: pre-wrap;\" dir=\"auto\" data-top-level=\"true\"><p style=\"margin-bottom:0;\">test</p></div>",
- "hs_object_id": "29564829699",
- "hs_product_name": null,
- "hs_queue_membership_ids": null,
- "hs_read_only": null,
- "hs_timestamp": "2023-01-05T06:57:42.491Z",
- "hs_unique_creation_key": null,
- "hs_unique_id": null,
- "hs_updated_by_user_id": "48320936",
- "hs_user_ids_of_all_notification_followers": null,
- "hs_user_ids_of_all_notification_unfollowers": null,
- "hs_user_ids_of_all_owners": "48320936",
- "hubspot_owner_assigneddate": "2023-01-05T06:57:42.491Z",
- "hubspot_owner_id": "269408298",
- "hubspot_team_id": null
}, - "createdAt": "2023-01-05T06:57:42.491Z",
- "updatedAt": "2023-01-05T06:57:42.491Z",
- "archived": false
}
}
}
An Appointment is a scheduled visit required to complete a Job.
Supported Source Systems include:
- ServiceTitan
For details on the Appointment data model and fields supported in Source Systems, see link.
All Appointments
This endpoint retrieves a list of Appointments a Linked User can access.
Authorizations:
header Parameters
API-Version required | string This value specifies which Agave API version to use.
The current version is |
Include-Source-Data | boolean Default: false A flag denoting whether you would like to also return the raw data from a Source System. |
Responses
Response samples
- 200
- 400
- 429
{- "data": [
- {
- "id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
- "source_id": "12345",
- "actual_duration": "180.0",
- "actual_end_time": "2022-01-01T00:00:00Z",
- "actual_start_time": "2022-01-01T00:00:00Z",
- "address": {
- "street_1": "123 Main Street",
- "street_2": "Unit 1",
- "city": "AnyTown",
- "state": "California",
- "country": "The United States of America",
- "postal_code": "19703"
}, - "arrival_window_end_time": "2022-01-01T00:00:00Z",
- "arrival_window_start_time": "2022-01-01T00:00:00Z",
- "description": "HVAC repair for AnyCompany Inc.",
- "number": "A123",
- "status": "Scheduled",
- "source_create_time": "2022-01-01T00:00:00Z",
- "source_update_time": "2022-01-01T00:00:00Z",
- "source_data": {
- "content_type": "application/json",
- "data": {
- "id": 12345,
- "jobId": 12345,
- "appointmentNumber": "A123",
- "start": "2022-01-01T00:00:00Z",
- "end": "2022-01-01T00:00:00Z",
- "arrivalWindowStart": "2022-01-01T00:00:00Z",
- "arrivalWindowEnd": "2022-01-01T00:00:00Z",
- "status": "Scheduled",
- "specialInstructions": "",
- "createdOn": "2022-01-01T00:00:00Z",
- "modifiedOn": "2022-01-01T00:00:00Z"
}
}
}
], - "meta": {
- "current_page": 1,
- "has_more_results": true
}
}
One Appointment
This endpoint retrieves an Appointment by its Agave UUID.
Authorizations:
path Parameters
id required | string <uuid> The UUID of the Appointment assigned by Agave. |
header Parameters
API-Version required | string This value specifies which Agave API version to use.
The current version is |
Include-Source-Data | boolean Default: false A flag denoting whether you would like to also return the raw data from a Source System. |
Responses
Response samples
- 200
- 429
{- "id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
- "source_id": "12345",
- "actual_duration": "180.0",
- "actual_end_time": "2022-01-01T00:00:00Z",
- "actual_start_time": "2022-01-01T00:00:00Z",
- "address": {
- "street_1": "123 Main Street",
- "street_2": "Unit 1",
- "city": "AnyTown",
- "state": "California",
- "country": "The United States of America",
- "postal_code": "19703"
}, - "arrival_window_end_time": "2022-01-01T00:00:00Z",
- "arrival_window_start_time": "2022-01-01T00:00:00Z",
- "description": "HVAC repair for AnyCompany Inc.",
- "number": "A123",
- "status": "Scheduled",
- "source_create_time": "2022-01-01T00:00:00Z",
- "source_update_time": "2022-01-01T00:00:00Z",
- "source_data": {
- "content_type": "application/json",
- "data": {
- "id": 12345,
- "jobId": 12345,
- "appointmentNumber": "A123",
- "start": "2022-01-01T00:00:00Z",
- "end": "2022-01-01T00:00:00Z",
- "arrivalWindowStart": "2022-01-01T00:00:00Z",
- "arrivalWindowEnd": "2022-01-01T00:00:00Z",
- "status": "Scheduled",
- "specialInstructions": "",
- "createdOn": "2022-01-01T00:00:00Z",
- "modifiedOn": "2022-01-01T00:00:00Z"
}
}
}
A Customer is a person or organization that buys goods and/or services from a Company.
Supported Source Systems include:
- Housecall Pro (read only)
- HubSpot ("Companies"; read and write)
- Pipedrive ("Organizations"; read only)
- QuickBooks Desktop (read and write)
- QuickBooks Online (read and write)
- ServiceTitan (read only)
- Viewpoint Spectrum (read only)
- Viewpoint Vista (read only)
For details on the Customer data model and fields supported in Source Systems, see link.
All Customers
This endpoint retrieves a list of Customers a Linked User can access.
Authorizations:
header Parameters
API-Version required | string This value specifies which Agave API version to use.
The current version is |
Include-Source-Data | boolean Default: false A flag denoting whether you would like to also return the raw data from a Source System. |
Responses
Response samples
- 200
- 400
- 429
{- "data": [
- {
- "id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
- "source_id": "12345",
- "addresses": [
- {
- "street_1": "123 Main Street",
- "street_2": "Unit 1",
- "city": "AnyTown",
- "state": "California",
- "country": "The United States of America",
- "postal_code": "19703"
}
], - "balance": "100.0",
- "currency_code": "USD",
- "email": "contact@agaveapi.com",
- "name": "John Doe",
- "phone": "(123) 555-0100",
- "status": "Active",
- "source_create_time": "2022-01-01T00:00:00Z",
- "source_update_time": "2022-01-01T00:00:00Z",
- "source_data": {
- "content_type": "application/json",
- "data": {
- "id": "12345",
- "first_name": "John",
- "last_name": "Doe",
- "email": "contact@agaveapi.com",
- "mobile_number": "(123) 555-0100",
- "home_number": null,
- "work_number": null,
- "company": "AnyCompany Inc.",
- "notifications_enabled": true,
- "lead_source": null,
- "company_name": "AnyCompany",
- "company_id": "12345",
- "tags": [ ],
- "addresses": [
- {
- "id": "12345",
- "type": "billing",
- "street": "123 Main Street",
- "street_line_2": "Unit B",
- "city": "AnyTown",
- "state": "DE",
- "zip": "19703",
- "country": "US"
}
]
}
}
}
], - "meta": {
- "current_page": 1,
- "has_more_results": true
}
}
Customer
This endpoint creates Customers.
Authorizations:
header Parameters
API-Version required | string This value specifies which Agave API version to use.
The current version is |
Include-Source-Data | boolean Default: false A flag denoting whether you would like to also return the raw data from a Source System. |
Request Body schema: application/json
Array of objects (Address) The addresses of the Customer. | |
balance | string The current balance of the Customer. |
string The email address for contacting the Customer. | |
name | string The name of the Customer. |
phone | string The phone number for contacting the Customer. |
website | string The web address of the Customer. |
Responses
Request samples
- Payload
{- "addresses": [
- {
- "street_1": "123 Main Street",
- "street_2": "Unit 1",
- "city": "AnyTown",
- "state": "California",
- "country": "The United States of America",
- "postal_code": "19703"
}
], - "balance": "100.0",
- "email": "contact@agaveapi.com",
- "name": "AnyCompany Inc.",
- "phone": "(123) 555-0100",
}
Response samples
- 200
- 400
- 429
{- "id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
- "source_id": "12345",
- "addresses": [
- {
- "street_1": "123 Main Street",
- "street_2": "Unit 1",
- "city": "AnyTown",
- "state": "California",
- "country": "The United States of America",
- "postal_code": "19703"
}
], - "balance": "100.0",
- "currency_code": "USD",
- "email": "contact@agaveapi.com",
- "name": "John Doe",
- "phone": "(123) 555-0100",
- "status": "Active",
- "source_create_time": "2022-01-01T00:00:00Z",
- "source_update_time": "2022-01-01T00:00:00Z",
- "source_data": {
- "content_type": "application/json",
- "data": {
- "id": "12345",
- "first_name": "John",
- "last_name": "Doe",
- "email": "contact@agaveapi.com",
- "mobile_number": "(123) 555-0100",
- "home_number": null,
- "work_number": null,
- "company": "AnyCompany Inc.",
- "notifications_enabled": true,
- "lead_source": null,
- "company_name": "AnyCompany",
- "company_id": "12345",
- "tags": [ ],
- "addresses": [
- {
- "id": "12345",
- "type": "billing",
- "street": "123 Main Street",
- "street_line_2": "Unit B",
- "city": "AnyTown",
- "state": "DE",
- "zip": "19703",
- "country": "US"
}
]
}
}
}
One Customer
This endpoint enables you to retrieve an Appointment by its Agave UUID.
Authorizations:
path Parameters
id required | string <uuid> The UUID of the Customer assigned by Agave. |
header Parameters
API-Version required | string This value specifies which Agave API version to use.
The current version is |
Include-Source-Data | boolean Default: false A flag denoting whether you would like to also return the raw data from a Source System. |
Responses
Response samples
- 200
- 429
{- "id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
- "source_id": "12345",
- "addresses": [
- {
- "street_1": "123 Main Street",
- "street_2": "Unit 1",
- "city": "AnyTown",
- "state": "California",
- "country": "The United States of America",
- "postal_code": "19703"
}
], - "balance": "100.0",
- "currency_code": "USD",
- "email": "contact@agaveapi.com",
- "name": "John Doe",
- "phone": "(123) 555-0100",
- "status": "Active",
- "source_create_time": "2022-01-01T00:00:00Z",
- "source_update_time": "2022-01-01T00:00:00Z",
- "source_data": {
- "content_type": "application/json",
- "data": {
- "id": "12345",
- "first_name": "John",
- "last_name": "Doe",
- "email": "contact@agaveapi.com",
- "mobile_number": "(123) 555-0100",
- "home_number": null,
- "work_number": null,
- "company": "AnyCompany Inc.",
- "notifications_enabled": true,
- "lead_source": null,
- "company_name": "AnyCompany",
- "company_id": "12345",
- "tags": [ ],
- "addresses": [
- {
- "id": "12345",
- "type": "billing",
- "street": "123 Main Street",
- "street_line_2": "Unit B",
- "city": "AnyTown",
- "state": "DE",
- "zip": "19703",
- "country": "US"
}
]
}
}
}
One Customer
This endpoint updates a Customer by its Agave UUID.
Authorizations:
path Parameters
id required | string <uuid> The UUID of the Customer assigned by Agave. |
header Parameters
API-Version required | string This value specifies which Agave API version to use.
The current version is |
Include-Source-Data | boolean Default: false A flag denoting whether you would like to also return the raw data from a Source System. |
Request Body schema: application/json
Array of objects (Address) The addresses of the Customer. | |
string The email address for contacting the Customer. | |
name | string The name of the Customer. |
phone | string The phone number for contacting the Customer. |
status | string Enum: "Active" "Archived" "Unknown" The current status of the Customer. |
website | string The web address of the Customer. |
Responses
Request samples
- Payload
{- "addresses": [
- {
- "street_1": "123 Main Street",
- "street_2": "Unit 1",
- "city": "AnyTown",
- "state": "California",
- "country": "The United States of America",
- "postal_code": "19703"
}
], - "email": "contact@agaveapi.com",
- "name": "AnyCompany Inc",
- "phone": "(123) 555-0100",
- "status": "Active",
}
Response samples
- 200
- 429
{- "id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
- "source_id": "12345",
- "addresses": [
- {
- "street_1": "123 Main Street",
- "street_2": "Unit 1",
- "city": "AnyTown",
- "state": "California",
- "country": "The United States of America",
- "postal_code": "19703"
}
], - "balance": "100.0",
- "currency_code": "USD",
- "email": "contact@agaveapi.com",
- "name": "John Doe",
- "phone": "(123) 555-0100",
- "status": "Active",
- "source_create_time": "2022-01-01T00:00:00Z",
- "source_update_time": "2022-01-01T00:00:00Z",
- "source_data": {
- "content_type": "application/json",
- "data": {
- "id": "12345",
- "first_name": "John",
- "last_name": "Doe",
- "email": "contact@agaveapi.com",
- "mobile_number": "(123) 555-0100",
- "home_number": null,
- "work_number": null,
- "company": "AnyCompany Inc.",
- "notifications_enabled": true,
- "lead_source": null,
- "company_name": "AnyCompany",
- "company_id": "12345",
- "tags": [ ],
- "addresses": [
- {
- "id": "12345",
- "type": "billing",
- "street": "123 Main Street",
- "street_line_2": "Unit B",
- "city": "AnyTown",
- "state": "DE",
- "zip": "19703",
- "country": "US"
}
]
}
}
}
One Customer
This endpoint can be used to delete a Customer by its Agave UUID. Note: This will trigger an "UPDATE" not a "DELETE" event for QuickBooks Online webhooks.
Authorizations:
path Parameters
id required | string <uuid> The UUID of the Customer assigned by Agave. |
header Parameters
API-Version required | string This value specifies which Agave API version to use.
The current version is |
Include-Source-Data | boolean Default: false A flag denoting whether you would like to also return the raw data from a Source System. |
Responses
Response samples
- 200
- 429
{- "id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
- "source_id": "12345",
- "addresses": [
- {
- "street_1": "123 Main Street",
- "street_2": "Unit 1",
- "city": "AnyTown",
- "state": "California",
- "country": "The United States of America",
- "postal_code": "19703"
}
], - "balance": "100.0",
- "currency_code": "USD",
- "email": "contact@agaveapi.com",
- "name": "John Doe",
- "phone": "(123) 555-0100",
- "status": "Active",
- "source_create_time": "2022-01-01T00:00:00Z",
- "source_update_time": "2022-01-01T00:00:00Z",
- "source_data": {
- "content_type": "application/json",
- "data": {
- "id": "12345",
- "first_name": "John",
- "last_name": "Doe",
- "email": "contact@agaveapi.com",
- "mobile_number": "(123) 555-0100",
- "home_number": null,
- "work_number": null,
- "company": "AnyCompany Inc.",
- "notifications_enabled": true,
- "lead_source": null,
- "company_name": "AnyCompany",
- "company_id": "12345",
- "tags": [ ],
- "addresses": [
- {
- "id": "12345",
- "type": "billing",
- "street": "123 Main Street",
- "street_line_2": "Unit B",
- "city": "AnyTown",
- "state": "DE",
- "zip": "19703",
- "country": "US"
}
]
}
}
}
A Lead represents a prospect or sales opportunity.
Supported Source Systems include:
- ServiceTitan
For details on the Lead data model and fields supported in Source Systems, see link.
All Leads
This endpoint retrieves a list of Leads a Linked User can access.
Authorizations:
header Parameters
API-Version required | string This value specifies which Agave API version to use.
The current version is |
Include-Source-Data | boolean Default: false A flag denoting whether you would like to also return the raw data from a Source System. |
Responses
Response samples
- 200
- 400
- 429
{- "data": [
- {
- "id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
- "source_id": "12345",
- "address": {
- "street_1": "123 Main Street",
- "street_2": "Unit 1",
- "city": "AnyTown",
- "state": "California",
- "country": "The United States of America",
- "postal_code": "19703"
}, - "customer_id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
- "status": "Active",
- "source_create_time": "2022-01-01T00:00:00Z",
- "source_update_time": "2022-01-01T00:00:00Z",
- "source_data": {
- "content_type": "application/json",
- "data": {
- "id": 12345,
- "active": true,
- "name": "John Doe",
- "type": "Commercial",
- "address": {
- "street": "123 Main Street",
- "unit": "Unit 1",
- "city": "AnyTown",
- "state": "CA",
- "zip": "19703",
- "country": "USA",
- "latitude": null,
- "longitude": null
}, - "customFields": [ ],
- "balance": 100,
- "doNotMail": false,
- "doNotService": false,
- "createdOn": "2022-01-01T00:00:00.000000Z",
- "createdById": 12345,
- "modifiedOn": "2022-01-01T00:00:00.000000Z",
- "mergedToId": null
}
}
}
], - "meta": {
- "current_page": 1,
- "has_more_results": true
}
}
One Lead
This endpoint retrieves a Lead by its Agave UUID.
Authorizations:
path Parameters
id required | string <uuid> The UUID of the Lead assigned by Agave. |
header Parameters
API-Version required | string This value specifies which Agave API version to use.
The current version is |
Include-Source-Data | boolean Default: false A flag denoting whether you would like to also return the raw data from a Source System. |
Responses
Response samples
- 200
- 429
{- "id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
- "source_id": "12345",
- "address": {
- "street_1": "123 Main Street",
- "street_2": "Unit 1",
- "city": "AnyTown",
- "state": "California",
- "country": "The United States of America",
- "postal_code": "19703"
}, - "customer_id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
- "status": "Active",
- "source_create_time": "2022-01-01T00:00:00Z",
- "source_update_time": "2022-01-01T00:00:00Z",
- "source_data": {
- "content_type": "application/json",
- "data": {
- "id": 12345,
- "active": true,
- "name": "John Doe",
- "type": "Commercial",
- "address": {
- "street": "123 Main Street",
- "unit": "Unit 1",
- "city": "AnyTown",
- "state": "CA",
- "zip": "19703",
- "country": "USA",
- "latitude": null,
- "longitude": null
}, - "customFields": [ ],
- "balance": 100,
- "doNotMail": false,
- "doNotService": false,
- "createdOn": "2022-01-01T00:00:00.000000Z",
- "createdById": 12345,
- "modifiedOn": "2022-01-01T00:00:00.000000Z",
- "mergedToId": null
}
}
}
An Opportunity represents a pending deal.
Supported Source Systems include:
- HubSpot ("Deals", read and write)
- Pipedrive ("Deals", read only)
- Salesforce (read only)
For details on the Opportunity data model and fields supported in Source Systems, see link.
All Opportunities
This endpoint retrieves a list of Opportunities a Linked User can access.
Authorizations:
header Parameters
API-Version required | string This value specifies which Agave API version to use.
The current version is |
Include-Source-Data | boolean Default: false A flag denoting whether you would like to also return the raw data from a Source System. |
Responses
Response samples
- 200
- 400
- 429
{- "data": [
- {
- "id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
- "source_id": "12345",
- "amount": "150000",
- "close_date": "2022-01-01",
- "contact_ids": [
- "ee9b53e7-f982-4be6-bc12-75f716d3ee94"
], - "creator_id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
- "customer_ids": [
- "ee9b53e7-f982-4be6-bc12-75f716d3ee94"
], - "description": "A new apartment building in South San Francisco.",
- "name": "123 Apartment Project",
- "probability": "10",
- "stage": "Qualification",
- "status": "Won",
- "type": "newbusiness",
- "source_create_time": "2022-01-01T00:00:00Z",
- "source_update_time": "2022-01-01T00:00:00Z",
- "source_data": {
- "content_type": "application/json",
- "data": {
- "id": "11058909066",
- "properties": {
- "amount": "150000",
- "amount_in_home_currency": "150000",
- "closed_lost_reason": null,
- "closed_won_reason": null,
- "closedate": "2022-12-01T05:37:00.951Z",
- "createdate": "2022-11-23T05:37:29.977Z",
- "days_to_close": "7",
- "deal_currency_code": null,
- "dealname": "123 Apartment Project",
- "dealstage": "qualifiedtobuy",
- "dealtype": null,
- "description": "DESC.",
- "engagements_last_meeting_booked": null,
- "engagements_last_meeting_booked_campaign": null,
- "engagements_last_meeting_booked_medium": null,
- "engagements_last_meeting_booked_source": null,
- "hs_acv": null,
- "hs_all_accessible_team_ids": null,
- "hs_all_assigned_business_unit_ids": null,
- "hs_all_collaborator_owner_ids": null,
- "hs_all_deal_split_owner_ids": null,
- "hs_all_owner_ids": "269408298",
- "hs_all_team_ids": null,
- "hs_analytics_latest_source": "OFFLINE",
- "hs_analytics_latest_source_company": "OFFLINE",
- "hs_analytics_latest_source_contact": "OFFLINE",
- "hs_analytics_latest_source_data_1": "INTEGRATION",
- "hs_analytics_latest_source_data_1_company": "INTEGRATION",
- "hs_analytics_latest_source_data_1_contact": "INTEGRATION",
- "hs_analytics_latest_source_data_2": "1267897",
- "hs_analytics_latest_source_data_2_company": "1267897",
- "hs_analytics_latest_source_data_2_contact": "1267897",
- "hs_analytics_latest_source_timestamp": "2022-11-23T05:36:36.047Z",
- "hs_analytics_latest_source_timestamp_company": null,
- "hs_analytics_latest_source_timestamp_contact": "2022-11-23T05:36:36.047Z",
- "hs_analytics_source": "OFFLINE",
- "hs_analytics_source_data_1": "API",
- "hs_analytics_source_data_2": "sample-contact",
- "hs_arr": null,
- "hs_campaign": null,
- "hs_closed_amount": "0",
- "hs_closed_amount_in_home_currency": "0",
- "hs_created_by_user_id": "48320936",
- "hs_createdate": "2022-11-23T05:37:29.977Z",
- "hs_date_entered_appointmentscheduled": "2022-11-23T05:37:29.977Z",
- "hs_date_entered_closedlost": null,
- "hs_date_entered_closedwon": null,
- "hs_date_entered_contractsent": null,
- "hs_date_entered_decisionmakerboughtin": null,
- "hs_date_entered_presentationscheduled": null,
- "hs_date_entered_qualifiedtobuy": "2022-11-23T05:37:29.977Z",
- "hs_date_exited_appointmentscheduled": "2022-11-23T05:37:29.977Z",
- "hs_date_exited_closedlost": null,
- "hs_date_exited_closedwon": null,
- "hs_date_exited_contractsent": null,
- "hs_date_exited_decisionmakerboughtin": null,
- "hs_date_exited_presentationscheduled": null,
- "hs_date_exited_qualifiedtobuy": null,
- "hs_deal_amount_calculation_preference": null,
- "hs_deal_stage_probability": "10",
- "hs_deal_stage_probability_shadow": "10",
- "hs_exchange_rate": null,
- "hs_forecast_amount": "150000",
- "hs_forecast_probability": null,
- "hs_is_closed": "false",
- "hs_is_closed_won": "false",
- "hs_is_deal_split": "false",
- "hs_lastmodifieddate": "2023-02-01T18:43:30.840Z",
- "hs_latest_meeting_activity": null,
- "hs_likelihood_to_close": null,
- "hs_line_item_global_term_hs_discount_percentage": null,
- "hs_line_item_global_term_hs_discount_percentage_enabled": null,
- "hs_line_item_global_term_hs_recurring_billing_period": null,
- "hs_line_item_global_term_hs_recurring_billing_period_enabled": null,
- "hs_line_item_global_term_hs_recurring_billing_start_date": null,
- "hs_line_item_global_term_hs_recurring_billing_start_date_enabled": null,
- "hs_line_item_global_term_recurringbillingfrequency": null,
- "hs_line_item_global_term_recurringbillingfrequency_enabled": null,
- "hs_manual_forecast_category": null,
- "hs_merged_object_ids": null,
- "hs_mrr": null,
- "hs_next_step": null,
- "hs_num_associated_active_deal_registrations": "0",
- "hs_num_associated_deal_registrations": "0",
- "hs_num_associated_deal_splits": "0",
- "hs_num_target_accounts": "0",
- "hs_object_id": "11058909066",
- "hs_pinned_engagement_id": null,
- "hs_predicted_amount": null,
- "hs_predicted_amount_in_home_currency": null,
- "hs_priority": null,
- "hs_projected_amount": "150000",
- "hs_projected_amount_in_home_currency": "150000",
- "hs_read_only": null,
- "hs_sales_email_last_replied": null,
- "hs_tag_ids": null,
- "hs_tcv": null,
- "hs_time_in_appointmentscheduled": "0",
- "hs_time_in_closedlost": null,
- "hs_time_in_closedwon": null,
- "hs_time_in_contractsent": null,
- "hs_time_in_decisionmakerboughtin": null,
- "hs_time_in_presentationscheduled": null,
- "hs_time_in_qualifiedtobuy": "6095210186",
- "hs_unique_creation_key": null,
- "hs_updated_by_user_id": "48320936",
- "hs_user_ids_of_all_notification_followers": null,
- "hs_user_ids_of_all_notification_unfollowers": null,
- "hs_user_ids_of_all_owners": "48320936",
- "hubspot_owner_assigneddate": "2022-11-23T05:37:29.977Z",
- "hubspot_owner_id": "269408298",
- "hubspot_team_id": null,
- "notes_last_contacted": null,
- "notes_last_updated": null,
- "notes_next_activity_date": null,
- "num_associated_contacts": "2",
- "num_contacted_notes": null,
- "num_notes": null,
- "pipeline": "default"
}, - "createdAt": "2022-11-23T05:37:29.977Z",
- "updatedAt": "2023-02-01T18:43:30.840Z",
- "archived": false,
- "associations": {
- "companies": {
- "results": [
- {
- "id": "11482706302",
- "type": "deal_to_company"
}, - {
- "id": "11470069166",
- "type": "deal_to_company_unlabeled"
}, - {
- "id": "11482706302",
- "type": "deal_to_company_unlabeled"
}
]
}, - "contacts": {
- "results": [
- {
- "id": "51",
- "type": "deal_to_contact"
}, - {
- "id": "151",
- "type": "deal_to_contact"
}
]
}
}
}
}
}
], - "meta": {
- "current_page": 1,
- "has_more_results": true
}
}
Opportunity
This endpoint creates Opportunities.
Authorizations:
header Parameters
API-Version required | string This value specifies which Agave API version to use.
The current version is |
Include-Source-Data | boolean Default: false A flag denoting whether you would like to also return the raw data from a Source System. |
Request Body schema: application/json
amount | string The monetary amount of the Opportunity. |
close_date | string <date> The date the Opportunity was closed. |
contact_ids | Array of strings <uuid> (IdPropertyWriteOnly) [ items <uuid > = 36 characters ] The UUID assigned by Agave of the Contact. |
customer_ids | Array of strings <uuid> (IdPropertyWriteOnly) [ items <uuid > = 36 characters ] The UUID assigned by Agave of the Customer. |
description | string A description of the Opportunity. |
name | string The name of the Opportunity. |
probability | string The probability assigned to winning the Opportunity. |
stage | string The current stage of the Opportunity. |
status | string The current status of the Opportunity. |
type | string The type of Opportunity. |
Responses
Request samples
- Payload
{- "amount": "150000",
- "close_date": "2022-01-01",
- "contact_ids": [
- "c840285e-e65f-4342-943f-5950ef8072dc"
], - "customer_ids": [
- "c840285e-e65f-4342-943f-5950ef8072dc"
], - "description": "A new apartment building in South San Francisco.",
- "name": "123 Apartment Project",
- "probability": "10",
- "stage": "Qualification",
- "status": "Won",
- "type": "newbusiness"
}
Response samples
- 200
- 400
- 429
{- "id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
- "source_id": "12345",
- "amount": "150000",
- "close_date": "2022-01-01",
- "contact_ids": [
- "ee9b53e7-f982-4be6-bc12-75f716d3ee94"
], - "creator_id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
- "customer_ids": [
- "ee9b53e7-f982-4be6-bc12-75f716d3ee94"
], - "description": "A new apartment building in South San Francisco.",
- "name": "123 Apartment Project",
- "probability": "10",
- "stage": "Qualification",
- "status": "Won",
- "type": "newbusiness",
- "source_create_time": "2022-01-01T00:00:00Z",
- "source_update_time": "2022-01-01T00:00:00Z",
- "source_data": {
- "content_type": "application/json",
- "data": {
- "id": "11058909066",
- "properties": {
- "amount": "150000",
- "amount_in_home_currency": "150000",
- "closed_lost_reason": null,
- "closed_won_reason": null,
- "closedate": "2022-12-01T05:37:00.951Z",
- "createdate": "2022-11-23T05:37:29.977Z",
- "days_to_close": "7",
- "deal_currency_code": null,
- "dealname": "123 Apartment Project",
- "dealstage": "qualifiedtobuy",
- "dealtype": null,
- "description": "DESC.",
- "engagements_last_meeting_booked": null,
- "engagements_last_meeting_booked_campaign": null,
- "engagements_last_meeting_booked_medium": null,
- "engagements_last_meeting_booked_source": null,
- "hs_acv": null,
- "hs_all_accessible_team_ids": null,
- "hs_all_assigned_business_unit_ids": null,
- "hs_all_collaborator_owner_ids": null,
- "hs_all_deal_split_owner_ids": null,
- "hs_all_owner_ids": "269408298",
- "hs_all_team_ids": null,
- "hs_analytics_latest_source": "OFFLINE",
- "hs_analytics_latest_source_company": "OFFLINE",
- "hs_analytics_latest_source_contact": "OFFLINE",
- "hs_analytics_latest_source_data_1": "INTEGRATION",
- "hs_analytics_latest_source_data_1_company": "INTEGRATION",
- "hs_analytics_latest_source_data_1_contact": "INTEGRATION",
- "hs_analytics_latest_source_data_2": "1267897",
- "hs_analytics_latest_source_data_2_company": "1267897",
- "hs_analytics_latest_source_data_2_contact": "1267897",
- "hs_analytics_latest_source_timestamp": "2022-11-23T05:36:36.047Z",
- "hs_analytics_latest_source_timestamp_company": null,
- "hs_analytics_latest_source_timestamp_contact": "2022-11-23T05:36:36.047Z",
- "hs_analytics_source": "OFFLINE",
- "hs_analytics_source_data_1": "API",
- "hs_analytics_source_data_2": "sample-contact",
- "hs_arr": null,
- "hs_campaign": null,
- "hs_closed_amount": "0",
- "hs_closed_amount_in_home_currency": "0",
- "hs_created_by_user_id": "48320936",
- "hs_createdate": "2022-11-23T05:37:29.977Z",
- "hs_date_entered_appointmentscheduled": "2022-11-23T05:37:29.977Z",
- "hs_date_entered_closedlost": null,
- "hs_date_entered_closedwon": null,
- "hs_date_entered_contractsent": null,
- "hs_date_entered_decisionmakerboughtin": null,
- "hs_date_entered_presentationscheduled": null,
- "hs_date_entered_qualifiedtobuy": "2022-11-23T05:37:29.977Z",
- "hs_date_exited_appointmentscheduled": "2022-11-23T05:37:29.977Z",
- "hs_date_exited_closedlost": null,
- "hs_date_exited_closedwon": null,
- "hs_date_exited_contractsent": null,
- "hs_date_exited_decisionmakerboughtin": null,
- "hs_date_exited_presentationscheduled": null,
- "hs_date_exited_qualifiedtobuy": null,
- "hs_deal_amount_calculation_preference": null,
- "hs_deal_stage_probability": "10",
- "hs_deal_stage_probability_shadow": "10",
- "hs_exchange_rate": null,
- "hs_forecast_amount": "150000",
- "hs_forecast_probability": null,
- "hs_is_closed": "false",
- "hs_is_closed_won": "false",
- "hs_is_deal_split": "false",
- "hs_lastmodifieddate": "2023-02-01T18:43:30.840Z",
- "hs_latest_meeting_activity": null,
- "hs_likelihood_to_close": null,
- "hs_line_item_global_term_hs_discount_percentage": null,
- "hs_line_item_global_term_hs_discount_percentage_enabled": null,
- "hs_line_item_global_term_hs_recurring_billing_period": null,
- "hs_line_item_global_term_hs_recurring_billing_period_enabled": null,
- "hs_line_item_global_term_hs_recurring_billing_start_date": null,
- "hs_line_item_global_term_hs_recurring_billing_start_date_enabled": null,
- "hs_line_item_global_term_recurringbillingfrequency": null,
- "hs_line_item_global_term_recurringbillingfrequency_enabled": null,
- "hs_manual_forecast_category": null,
- "hs_merged_object_ids": null,
- "hs_mrr": null,
- "hs_next_step": null,
- "hs_num_associated_active_deal_registrations": "0",
- "hs_num_associated_deal_registrations": "0",
- "hs_num_associated_deal_splits": "0",
- "hs_num_target_accounts": "0",
- "hs_object_id": "11058909066",
- "hs_pinned_engagement_id": null,
- "hs_predicted_amount": null,
- "hs_predicted_amount_in_home_currency": null,
- "hs_priority": null,
- "hs_projected_amount": "150000",
- "hs_projected_amount_in_home_currency": "150000",
- "hs_read_only": null,
- "hs_sales_email_last_replied": null,
- "hs_tag_ids": null,
- "hs_tcv": null,
- "hs_time_in_appointmentscheduled": "0",
- "hs_time_in_closedlost": null,
- "hs_time_in_closedwon": null,
- "hs_time_in_contractsent": null,
- "hs_time_in_decisionmakerboughtin": null,
- "hs_time_in_presentationscheduled": null,
- "hs_time_in_qualifiedtobuy": "6095210186",
- "hs_unique_creation_key": null,
- "hs_updated_by_user_id": "48320936",
- "hs_user_ids_of_all_notification_followers": null,
- "hs_user_ids_of_all_notification_unfollowers": null,
- "hs_user_ids_of_all_owners": "48320936",
- "hubspot_owner_assigneddate": "2022-11-23T05:37:29.977Z",
- "hubspot_owner_id": "269408298",
- "hubspot_team_id": null,
- "notes_last_contacted": null,
- "notes_last_updated": null,
- "notes_next_activity_date": null,
- "num_associated_contacts": "2",
- "num_contacted_notes": null,
- "num_notes": null,
- "pipeline": "default"
}, - "createdAt": "2022-11-23T05:37:29.977Z",
- "updatedAt": "2023-02-01T18:43:30.840Z",
- "archived": false,
- "associations": {
- "companies": {
- "results": [
- {
- "id": "11482706302",
- "type": "deal_to_company"
}, - {
- "id": "11470069166",
- "type": "deal_to_company_unlabeled"
}, - {
- "id": "11482706302",
- "type": "deal_to_company_unlabeled"
}
]
}, - "contacts": {
- "results": [
- {
- "id": "51",
- "type": "deal_to_contact"
}, - {
- "id": "151",
- "type": "deal_to_contact"
}
]
}
}
}
}
}
One Opportunity
This endpoint retrieves an Opportunity by its Agave UUID.
Authorizations:
path Parameters
id required | string <uuid> The UUID of the Opportunity assigned by Agave. |
header Parameters
API-Version required | string This value specifies which Agave API version to use.
The current version is |
Include-Source-Data | boolean Default: false A flag denoting whether you would like to also return the raw data from a Source System. |
Responses
Response samples
- 200
- 429
{- "id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
- "source_id": "12345",
- "amount": "150000",
- "close_date": "2022-01-01",
- "contact_ids": [
- "ee9b53e7-f982-4be6-bc12-75f716d3ee94"
], - "creator_id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
- "customer_ids": [
- "ee9b53e7-f982-4be6-bc12-75f716d3ee94"
], - "description": "A new apartment building in South San Francisco.",
- "name": "123 Apartment Project",
- "probability": "10",
- "stage": "Qualification",
- "status": "Won",
- "type": "newbusiness",
- "source_create_time": "2022-01-01T00:00:00Z",
- "source_update_time": "2022-01-01T00:00:00Z",
- "source_data": {
- "content_type": "application/json",
- "data": {
- "id": "11058909066",
- "properties": {
- "amount": "150000",
- "amount_in_home_currency": "150000",
- "closed_lost_reason": null,
- "closed_won_reason": null,
- "closedate": "2022-12-01T05:37:00.951Z",
- "createdate": "2022-11-23T05:37:29.977Z",
- "days_to_close": "7",
- "deal_currency_code": null,
- "dealname": "123 Apartment Project",
- "dealstage": "qualifiedtobuy",
- "dealtype": null,
- "description": "DESC.",
- "engagements_last_meeting_booked": null,
- "engagements_last_meeting_booked_campaign": null,
- "engagements_last_meeting_booked_medium": null,
- "engagements_last_meeting_booked_source": null,
- "hs_acv": null,
- "hs_all_accessible_team_ids": null,
- "hs_all_assigned_business_unit_ids": null,
- "hs_all_collaborator_owner_ids": null,
- "hs_all_deal_split_owner_ids": null,
- "hs_all_owner_ids": "269408298",
- "hs_all_team_ids": null,
- "hs_analytics_latest_source": "OFFLINE",
- "hs_analytics_latest_source_company": "OFFLINE",
- "hs_analytics_latest_source_contact": "OFFLINE",
- "hs_analytics_latest_source_data_1": "INTEGRATION",
- "hs_analytics_latest_source_data_1_company": "INTEGRATION",
- "hs_analytics_latest_source_data_1_contact": "INTEGRATION",
- "hs_analytics_latest_source_data_2": "1267897",
- "hs_analytics_latest_source_data_2_company": "1267897",
- "hs_analytics_latest_source_data_2_contact": "1267897",
- "hs_analytics_latest_source_timestamp": "2022-11-23T05:36:36.047Z",
- "hs_analytics_latest_source_timestamp_company": null,
- "hs_analytics_latest_source_timestamp_contact": "2022-11-23T05:36:36.047Z",
- "hs_analytics_source": "OFFLINE",
- "hs_analytics_source_data_1": "API",
- "hs_analytics_source_data_2": "sample-contact",
- "hs_arr": null,
- "hs_campaign": null,
- "hs_closed_amount": "0",
- "hs_closed_amount_in_home_currency": "0",
- "hs_created_by_user_id": "48320936",
- "hs_createdate": "2022-11-23T05:37:29.977Z",
- "hs_date_entered_appointmentscheduled": "2022-11-23T05:37:29.977Z",
- "hs_date_entered_closedlost": null,
- "hs_date_entered_closedwon": null,
- "hs_date_entered_contractsent": null,
- "hs_date_entered_decisionmakerboughtin": null,
- "hs_date_entered_presentationscheduled": null,
- "hs_date_entered_qualifiedtobuy": "2022-11-23T05:37:29.977Z",
- "hs_date_exited_appointmentscheduled": "2022-11-23T05:37:29.977Z",
- "hs_date_exited_closedlost": null,
- "hs_date_exited_closedwon": null,
- "hs_date_exited_contractsent": null,
- "hs_date_exited_decisionmakerboughtin": null,
- "hs_date_exited_presentationscheduled": null,
- "hs_date_exited_qualifiedtobuy": null,
- "hs_deal_amount_calculation_preference": null,
- "hs_deal_stage_probability": "10",
- "hs_deal_stage_probability_shadow": "10",
- "hs_exchange_rate": null,
- "hs_forecast_amount": "150000",
- "hs_forecast_probability": null,
- "hs_is_closed": "false",
- "hs_is_closed_won": "false",
- "hs_is_deal_split": "false",
- "hs_lastmodifieddate": "2023-02-01T18:43:30.840Z",
- "hs_latest_meeting_activity": null,
- "hs_likelihood_to_close": null,
- "hs_line_item_global_term_hs_discount_percentage": null,
- "hs_line_item_global_term_hs_discount_percentage_enabled": null,
- "hs_line_item_global_term_hs_recurring_billing_period": null,
- "hs_line_item_global_term_hs_recurring_billing_period_enabled": null,
- "hs_line_item_global_term_hs_recurring_billing_start_date": null,
- "hs_line_item_global_term_hs_recurring_billing_start_date_enabled": null,
- "hs_line_item_global_term_recurringbillingfrequency": null,
- "hs_line_item_global_term_recurringbillingfrequency_enabled": null,
- "hs_manual_forecast_category": null,
- "hs_merged_object_ids": null,
- "hs_mrr": null,
- "hs_next_step": null,
- "hs_num_associated_active_deal_registrations": "0",
- "hs_num_associated_deal_registrations": "0",
- "hs_num_associated_deal_splits": "0",
- "hs_num_target_accounts": "0",
- "hs_object_id": "11058909066",
- "hs_pinned_engagement_id": null,
- "hs_predicted_amount": null,
- "hs_predicted_amount_in_home_currency": null,
- "hs_priority": null,
- "hs_projected_amount": "150000",
- "hs_projected_amount_in_home_currency": "150000",
- "hs_read_only": null,
- "hs_sales_email_last_replied": null,
- "hs_tag_ids": null,
- "hs_tcv": null,
- "hs_time_in_appointmentscheduled": "0",
- "hs_time_in_closedlost": null,
- "hs_time_in_closedwon": null,
- "hs_time_in_contractsent": null,
- "hs_time_in_decisionmakerboughtin": null,
- "hs_time_in_presentationscheduled": null,
- "hs_time_in_qualifiedtobuy": "6095210186",
- "hs_unique_creation_key": null,
- "hs_updated_by_user_id": "48320936",
- "hs_user_ids_of_all_notification_followers": null,
- "hs_user_ids_of_all_notification_unfollowers": null,
- "hs_user_ids_of_all_owners": "48320936",
- "hubspot_owner_assigneddate": "2022-11-23T05:37:29.977Z",
- "hubspot_owner_id": "269408298",
- "hubspot_team_id": null,
- "notes_last_contacted": null,
- "notes_last_updated": null,
- "notes_next_activity_date": null,
- "num_associated_contacts": "2",
- "num_contacted_notes": null,
- "num_notes": null,
- "pipeline": "default"
}, - "createdAt": "2022-11-23T05:37:29.977Z",
- "updatedAt": "2023-02-01T18:43:30.840Z",
- "archived": false,
- "associations": {
- "companies": {
- "results": [
- {
- "id": "11482706302",
- "type": "deal_to_company"
}, - {
- "id": "11470069166",
- "type": "deal_to_company_unlabeled"
}, - {
- "id": "11482706302",
- "type": "deal_to_company_unlabeled"
}
]
}, - "contacts": {
- "results": [
- {
- "id": "51",
- "type": "deal_to_contact"
}, - {
- "id": "151",
- "type": "deal_to_contact"
}
]
}
}
}
}
}
One Opportunity
This endpoint updates a Opportunity by its Agave UUID.
Authorizations:
path Parameters
id required | string <uuid> The UUID of the Opportunity assigned by Agave. |
header Parameters
API-Version required | string This value specifies which Agave API version to use.
The current version is |
Include-Source-Data | boolean Default: false A flag denoting whether you would like to also return the raw data from a Source System. |
Request Body schema: application/json
amount | string The monetary amount of the Opportunity. |
close_date | string <date> The date the Opportunity was closed. |
contact_ids | Array of strings <uuid> (IdPropertyWriteOnly) [ items <uuid > = 36 characters ] The UUID assigned by Agave of the Contact. |
customer_ids | Array of strings <uuid> (IdPropertyWriteOnly) [ items <uuid > = 36 characters ] The UUID assigned by Agave of the Customer. |
description | string A description of the Opportunity. |
name | string The name of the Opportunity. |
probability | string The probability assigned to winning the Opportunity. |
stage | string The current stage of the Opportunity. |
status | string The current status of the Opportunity. |
type | string The type of Opportunity. |
Responses
Request samples
- Payload
{- "amount": "150000",
- "close_date": "2022-01-01",
- "contact_ids": [
- "c840285e-e65f-4342-943f-5950ef8072dc"
], - "customer_ids": [
- "c840285e-e65f-4342-943f-5950ef8072dc"
], - "description": "A new apartment building in South San Francisco.",
- "name": "123 Apartment Project",
- "probability": "10",
- "stage": "Qualification",
- "status": "Won",
- "type": "newbusiness"
}
Response samples
- 200
- 429
{- "id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
- "source_id": "12345",
- "amount": "150000",
- "close_date": "2022-01-01",
- "contact_ids": [
- "ee9b53e7-f982-4be6-bc12-75f716d3ee94"
], - "creator_id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
- "customer_ids": [
- "ee9b53e7-f982-4be6-bc12-75f716d3ee94"
], - "description": "A new apartment building in South San Francisco.",
- "name": "123 Apartment Project",
- "probability": "10",
- "stage": "Qualification",
- "status": "Won",
- "type": "newbusiness",
- "source_create_time": "2022-01-01T00:00:00Z",
- "source_update_time": "2022-01-01T00:00:00Z",
- "source_data": {
- "content_type": "application/json",
- "data": {
- "id": "11058909066",
- "properties": {
- "amount": "150000",
- "amount_in_home_currency": "150000",
- "closed_lost_reason": null,
- "closed_won_reason": null,
- "closedate": "2022-12-01T05:37:00.951Z",
- "createdate": "2022-11-23T05:37:29.977Z",
- "days_to_close": "7",
- "deal_currency_code": null,
- "dealname": "123 Apartment Project",
- "dealstage": "qualifiedtobuy",
- "dealtype": null,
- "description": "DESC.",
- "engagements_last_meeting_booked": null,
- "engagements_last_meeting_booked_campaign": null,
- "engagements_last_meeting_booked_medium": null,
- "engagements_last_meeting_booked_source": null,
- "hs_acv": null,
- "hs_all_accessible_team_ids": null,
- "hs_all_assigned_business_unit_ids": null,
- "hs_all_collaborator_owner_ids": null,
- "hs_all_deal_split_owner_ids": null,
- "hs_all_owner_ids": "269408298",
- "hs_all_team_ids": null,
- "hs_analytics_latest_source": "OFFLINE",
- "hs_analytics_latest_source_company": "OFFLINE",
- "hs_analytics_latest_source_contact": "OFFLINE",
- "hs_analytics_latest_source_data_1": "INTEGRATION",
- "hs_analytics_latest_source_data_1_company": "INTEGRATION",
- "hs_analytics_latest_source_data_1_contact": "INTEGRATION",
- "hs_analytics_latest_source_data_2": "1267897",
- "hs_analytics_latest_source_data_2_company": "1267897",
- "hs_analytics_latest_source_data_2_contact": "1267897",
- "hs_analytics_latest_source_timestamp": "2022-11-23T05:36:36.047Z",
- "hs_analytics_latest_source_timestamp_company": null,
- "hs_analytics_latest_source_timestamp_contact": "2022-11-23T05:36:36.047Z",
- "hs_analytics_source": "OFFLINE",
- "hs_analytics_source_data_1": "API",
- "hs_analytics_source_data_2": "sample-contact",
- "hs_arr": null,
- "hs_campaign": null,
- "hs_closed_amount": "0",
- "hs_closed_amount_in_home_currency": "0",
- "hs_created_by_user_id": "48320936",
- "hs_createdate": "2022-11-23T05:37:29.977Z",
- "hs_date_entered_appointmentscheduled": "2022-11-23T05:37:29.977Z",
- "hs_date_entered_closedlost": null,
- "hs_date_entered_closedwon": null,
- "hs_date_entered_contractsent": null,
- "hs_date_entered_decisionmakerboughtin": null,
- "hs_date_entered_presentationscheduled": null,
- "hs_date_entered_qualifiedtobuy": "2022-11-23T05:37:29.977Z",
- "hs_date_exited_appointmentscheduled": "2022-11-23T05:37:29.977Z",
- "hs_date_exited_closedlost": null,
- "hs_date_exited_closedwon": null,
- "hs_date_exited_contractsent": null,
- "hs_date_exited_decisionmakerboughtin": null,
- "hs_date_exited_presentationscheduled": null,
- "hs_date_exited_qualifiedtobuy": null,
- "hs_deal_amount_calculation_preference": null,
- "hs_deal_stage_probability": "10",
- "hs_deal_stage_probability_shadow": "10",
- "hs_exchange_rate": null,
- "hs_forecast_amount": "150000",
- "hs_forecast_probability": null,
- "hs_is_closed": "false",
- "hs_is_closed_won": "false",
- "hs_is_deal_split": "false",
- "hs_lastmodifieddate": "2023-02-01T18:43:30.840Z",
- "hs_latest_meeting_activity": null,
- "hs_likelihood_to_close": null,
- "hs_line_item_global_term_hs_discount_percentage": null,
- "hs_line_item_global_term_hs_discount_percentage_enabled": null,
- "hs_line_item_global_term_hs_recurring_billing_period": null,
- "hs_line_item_global_term_hs_recurring_billing_period_enabled": null,
- "hs_line_item_global_term_hs_recurring_billing_start_date": null,
- "hs_line_item_global_term_hs_recurring_billing_start_date_enabled": null,
- "hs_line_item_global_term_recurringbillingfrequency": null,
- "hs_line_item_global_term_recurringbillingfrequency_enabled": null,
- "hs_manual_forecast_category": null,
- "hs_merged_object_ids": null,
- "hs_mrr": null,
- "hs_next_step": null,
- "hs_num_associated_active_deal_registrations": "0",
- "hs_num_associated_deal_registrations": "0",
- "hs_num_associated_deal_splits": "0",
- "hs_num_target_accounts": "0",
- "hs_object_id": "11058909066",
- "hs_pinned_engagement_id": null,
- "hs_predicted_amount": null,
- "hs_predicted_amount_in_home_currency": null,
- "hs_priority": null,
- "hs_projected_amount": "150000",
- "hs_projected_amount_in_home_currency": "150000",
- "hs_read_only": null,
- "hs_sales_email_last_replied": null,
- "hs_tag_ids": null,
- "hs_tcv": null,
- "hs_time_in_appointmentscheduled": "0",
- "hs_time_in_closedlost": null,
- "hs_time_in_closedwon": null,
- "hs_time_in_contractsent": null,
- "hs_time_in_decisionmakerboughtin": null,
- "hs_time_in_presentationscheduled": null,
- "hs_time_in_qualifiedtobuy": "6095210186",
- "hs_unique_creation_key": null,
- "hs_updated_by_user_id": "48320936",
- "hs_user_ids_of_all_notification_followers": null,
- "hs_user_ids_of_all_notification_unfollowers": null,
- "hs_user_ids_of_all_owners": "48320936",
- "hubspot_owner_assigneddate": "2022-11-23T05:37:29.977Z",
- "hubspot_owner_id": "269408298",
- "hubspot_team_id": null,
- "notes_last_contacted": null,
- "notes_last_updated": null,
- "notes_next_activity_date": null,
- "num_associated_contacts": "2",
- "num_contacted_notes": null,
- "num_notes": null,
- "pipeline": "default"
}, - "createdAt": "2022-11-23T05:37:29.977Z",
- "updatedAt": "2023-02-01T18:43:30.840Z",
- "archived": false,
- "associations": {
- "companies": {
- "results": [
- {
- "id": "11482706302",
- "type": "deal_to_company"
}, - {
- "id": "11470069166",
- "type": "deal_to_company_unlabeled"
}, - {
- "id": "11482706302",
- "type": "deal_to_company_unlabeled"
}
]
}, - "contacts": {
- "results": [
- {
- "id": "51",
- "type": "deal_to_contact"
}, - {
- "id": "151",
- "type": "deal_to_contact"
}
]
}
}
}
}
}
One Opportunity
This endpoint can be used to delete a Opportunity by its Agave UUID.
Authorizations:
path Parameters
id required | string <uuid> The UUID of the Opportunity assigned by Agave. |
header Parameters
API-Version required | string This value specifies which Agave API version to use.
The current version is |
Include-Source-Data | boolean Default: false A flag denoting whether you would like to also return the raw data from a Source System. |
Responses
Response samples
- 200
- 429
{- "id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
- "source_id": "12345",
- "amount": "150000",
- "close_date": "2022-01-01",
- "contact_ids": [
- "ee9b53e7-f982-4be6-bc12-75f716d3ee94"
], - "creator_id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
- "customer_ids": [
- "ee9b53e7-f982-4be6-bc12-75f716d3ee94"
], - "description": "A new apartment building in South San Francisco.",
- "name": "123 Apartment Project",
- "probability": "10",
- "stage": "Qualification",
- "status": "Won",
- "type": "newbusiness",
- "source_create_time": "2022-01-01T00:00:00Z",
- "source_update_time": "2022-01-01T00:00:00Z",
- "source_data": {
- "content_type": "application/json",
- "data": {
- "id": "11058909066",
- "properties": {
- "amount": "150000",
- "amount_in_home_currency": "150000",
- "closed_lost_reason": null,
- "closed_won_reason": null,
- "closedate": "2022-12-01T05:37:00.951Z",
- "createdate": "2022-11-23T05:37:29.977Z",
- "days_to_close": "7",
- "deal_currency_code": null,
- "dealname": "123 Apartment Project",
- "dealstage": "qualifiedtobuy",
- "dealtype": null,
- "description": "DESC.",
- "engagements_last_meeting_booked": null,
- "engagements_last_meeting_booked_campaign": null,
- "engagements_last_meeting_booked_medium": null,
- "engagements_last_meeting_booked_source": null,
- "hs_acv": null,
- "hs_all_accessible_team_ids": null,
- "hs_all_assigned_business_unit_ids": null,
- "hs_all_collaborator_owner_ids": null,
- "hs_all_deal_split_owner_ids": null,
- "hs_all_owner_ids": "269408298",
- "hs_all_team_ids": null,
- "hs_analytics_latest_source": "OFFLINE",
- "hs_analytics_latest_source_company": "OFFLINE",
- "hs_analytics_latest_source_contact": "OFFLINE",
- "hs_analytics_latest_source_data_1": "INTEGRATION",
- "hs_analytics_latest_source_data_1_company": "INTEGRATION",
- "hs_analytics_latest_source_data_1_contact": "INTEGRATION",
- "hs_analytics_latest_source_data_2": "1267897",
- "hs_analytics_latest_source_data_2_company": "1267897",
- "hs_analytics_latest_source_data_2_contact": "1267897",
- "hs_analytics_latest_source_timestamp": "2022-11-23T05:36:36.047Z",
- "hs_analytics_latest_source_timestamp_company": null,
- "hs_analytics_latest_source_timestamp_contact": "2022-11-23T05:36:36.047Z",
- "hs_analytics_source": "OFFLINE",
- "hs_analytics_source_data_1": "API",
- "hs_analytics_source_data_2": "sample-contact",
- "hs_arr": null,
- "hs_campaign": null,
- "hs_closed_amount": "0",
- "hs_closed_amount_in_home_currency": "0",
- "hs_created_by_user_id": "48320936",
- "hs_createdate": "2022-11-23T05:37:29.977Z",
- "hs_date_entered_appointmentscheduled": "2022-11-23T05:37:29.977Z",
- "hs_date_entered_closedlost": null,
- "hs_date_entered_closedwon": null,
- "hs_date_entered_contractsent": null,
- "hs_date_entered_decisionmakerboughtin": null,
- "hs_date_entered_presentationscheduled": null,
- "hs_date_entered_qualifiedtobuy": "2022-11-23T05:37:29.977Z",
- "hs_date_exited_appointmentscheduled": "2022-11-23T05:37:29.977Z",
- "hs_date_exited_closedlost": null,
- "hs_date_exited_closedwon": null,
- "hs_date_exited_contractsent": null,
- "hs_date_exited_decisionmakerboughtin": null,
- "hs_date_exited_presentationscheduled": null,
- "hs_date_exited_qualifiedtobuy": null,
- "hs_deal_amount_calculation_preference": null,
- "hs_deal_stage_probability": "10",
- "hs_deal_stage_probability_shadow": "10",
- "hs_exchange_rate": null,
- "hs_forecast_amount": "150000",
- "hs_forecast_probability": null,
- "hs_is_closed": "false",
- "hs_is_closed_won": "false",
- "hs_is_deal_split": "false",
- "hs_lastmodifieddate": "2023-02-01T18:43:30.840Z",
- "hs_latest_meeting_activity": null,
- "hs_likelihood_to_close": null,
- "hs_line_item_global_term_hs_discount_percentage": null,
- "hs_line_item_global_term_hs_discount_percentage_enabled": null,
- "hs_line_item_global_term_hs_recurring_billing_period": null,
- "hs_line_item_global_term_hs_recurring_billing_period_enabled": null,
- "hs_line_item_global_term_hs_recurring_billing_start_date": null,
- "hs_line_item_global_term_hs_recurring_billing_start_date_enabled": null,
- "hs_line_item_global_term_recurringbillingfrequency": null,
- "hs_line_item_global_term_recurringbillingfrequency_enabled": null,
- "hs_manual_forecast_category": null,
- "hs_merged_object_ids": null,
- "hs_mrr": null,
- "hs_next_step": null,
- "hs_num_associated_active_deal_registrations": "0",
- "hs_num_associated_deal_registrations": "0",
- "hs_num_associated_deal_splits": "0",
- "hs_num_target_accounts": "0",
- "hs_object_id": "11058909066",
- "hs_pinned_engagement_id": null,
- "hs_predicted_amount": null,
- "hs_predicted_amount_in_home_currency": null,
- "hs_priority": null,
- "hs_projected_amount": "150000",
- "hs_projected_amount_in_home_currency": "150000",
- "hs_read_only": null,
- "hs_sales_email_last_replied": null,
- "hs_tag_ids": null,
- "hs_tcv": null,
- "hs_time_in_appointmentscheduled": "0",
- "hs_time_in_closedlost": null,
- "hs_time_in_closedwon": null,
- "hs_time_in_contractsent": null,
- "hs_time_in_decisionmakerboughtin": null,
- "hs_time_in_presentationscheduled": null,
- "hs_time_in_qualifiedtobuy": "6095210186",
- "hs_unique_creation_key": null,
- "hs_updated_by_user_id": "48320936",
- "hs_user_ids_of_all_notification_followers": null,
- "hs_user_ids_of_all_notification_unfollowers": null,
- "hs_user_ids_of_all_owners": "48320936",
- "hubspot_owner_assigneddate": "2022-11-23T05:37:29.977Z",
- "hubspot_owner_id": "269408298",
- "hubspot_team_id": null,
- "notes_last_contacted": null,
- "notes_last_updated": null,
- "notes_next_activity_date": null,
- "num_associated_contacts": "2",
- "num_contacted_notes": null,
- "num_notes": null,
- "pipeline": "default"
}, - "createdAt": "2022-11-23T05:37:29.977Z",
- "updatedAt": "2023-02-01T18:43:30.840Z",
- "archived": false,
- "associations": {
- "companies": {
- "results": [
- {
- "id": "11482706302",
- "type": "deal_to_company"
}, - {
- "id": "11470069166",
- "type": "deal_to_company_unlabeled"
}, - {
- "id": "11482706302",
- "type": "deal_to_company_unlabeled"
}
]
}, - "contacts": {
- "results": [
- {
- "id": "51",
- "type": "deal_to_contact"
}, - {
- "id": "151",
- "type": "deal_to_contact"
}
]
}
}
}
}
}
An Activity is an event on a calendar that can be associated with an opportunity, a contact, and/or a customer.
id | string <uuid> The UUID of the Activity assigned by Agave. |
source_id | string The ID of the Activity in the Source System. |
activity_time | string <date-time> The datetime for the Activity. |
attachment_ids | Array of strings <uuid> (IdPropertyReadOnly) The UUID assigned by Agave of the attached File. |
description | string The description of the Activity. Supporting HTML markup. |
subject | string The subject of the Activity. |
type | string The type of the Activity. |
source_create_time | string <date-time> The datetime the Activity was created. |
source_update_time | string <date-time> The datetime the Activity was last updated. |
{- "id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
- "source_id": "12345",
- "activity_time": "2022-01-01T00:00:00Z",
- "attachment_ids": [
- "ee9b53e7-f982-4be6-bc12-75f716d3ee94"
], - "description": "Latest <strong>notes</strong>.",
- "subject": "Check-in on Status",
- "type": "note",
- "source_create_time": "2022-01-01T00:00:00Z",
- "source_update_time": "2022-01-01T00:00:00Z"
}
An Appointment is a scheduled visit required to complete a Job.
id | string <uuid> The UUID of the Appointment assigned by Agave. |
source_id | string The ID of the Appointment in the Source System. |
actual_duration | string The duration of the Appointment (in minutes). |
actual_end_time | string <date-time> The datetime of the actual end of the Appointment. |
actual_start_time | string <date-time> The datetime of the actual start of the Appointment. |
object (Address) | |
arrival_window_end_time | string <date-time> The datetime of the end of the Appointment's window. |
arrival_window_start_time | string <date-time> The datetime of the start of the Appointment's window. |
description | string A summary of the Appointment. |
number | string The number of the Appointment. |
status | string The status of the Appointment. |
source_create_time | string <date-time> The datetime the Appointment was created in the Source System. |
source_update_time | string <date-time> The datetime the Appointment was last updated in the Source System. |
{- "id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
- "source_id": "12345",
- "actual_duration": "180.0",
- "actual_end_time": "2022-01-01T00:00:00Z",
- "actual_start_time": "2022-01-01T00:00:00Z",
- "address": {
- "street_1": "123 Main Street",
- "street_2": "Unit 1",
- "city": "AnyTown",
- "state": "California",
- "country": "The United States of America",
- "postal_code": "19703"
}, - "arrival_window_end_time": "2022-01-01T00:00:00Z",
- "arrival_window_start_time": "2022-01-01T00:00:00Z",
- "description": "HVAC repair for AnyCompany Inc.",
- "number": "A123",
- "status": "Scheduled",
- "source_create_time": "2022-01-01T00:00:00Z",
- "source_update_time": "2022-01-01T00:00:00Z"
}
Supported fields in each Source System:
Field | Salesforce | ServiceTitan |
---|---|---|
actual_duration |
🔜 | ✅ |
actual_end_time |
🔜 | ✅ |
actual_start_time |
🔜 | ✅ |
address |
🔜 | ✅ |
appointment_number |
🔜 | ✅ |
arrival_window_end_time |
🔜 | ✅ |
description |
🔜 | ✅ |
status |
🔜 | ✅ |
source_create_time |
🔜 | ✅ |
source_update_time |
🔜 | ✅ |
✅ Supported and mapped
🟡 Partially mapped, not exact match
🔜 Launching soon
➖ Not supported in source system
A Customer is a person or organization that buys goods and/or services from a Company.
id | string <uuid> The UUID of the Customer assigned by Agave. |
source_id | string The ID of the Customer in the Source System. |
Array of objects (Address) The addresses of the Customer. | |
balance | string The current balance of the Customer. |
currency_code | string The code of the default currency used for the Customer's transactions. Valid values are ISO 4217 codes. |
string The email address for contacting the Customer. | |
name | string The name of the Customer. |
phone | string The phone number for contacting the Customer. |
status | string Enum: "Active" "Archived" "Unknown" The current status of the Customer. |
website | string The web address of the Customer. |
source_create_time | string <date-time> The datetime the Customer was created in the Source System. |
source_update_time | string <date-time> The datetime the Customer was last updated in the Source System. |
{- "id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
- "source_id": "12345",
- "addresses": [
- {
- "street_1": "123 Main Street",
- "street_2": "Unit 1",
- "city": "AnyTown",
- "state": "California",
- "country": "The United States of America",
- "postal_code": "19703"
}
], - "balance": "100.0",
- "currency_code": "USD",
- "email": "contact@agaveapi.com",
- "name": "John Doe",
- "phone": "(123) 555-0100",
- "status": "Active",
- "source_create_time": "2022-01-01T00:00:00Z",
- "source_update_time": "2022-01-01T00:00:00Z"
}
Supported fields in each Source System:
Field | HouseCall Pro | HubSpot | QuickBooks Desktop | QuickBooks Online | ServiceTitan | Viewpoint Spectrum | Viewpoint Vista |
---|---|---|---|---|---|---|---|
addresses |
✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
balance |
➖ | ➖ | ✅ | ✅ | ✅ | ➖ | ➖ |
currency_code |
➖ | ➖ | ✅ | ✅ | ➖ | ➖ | ➖ |
email |
✅ | ✅ | ✅ | ✅ | ➖ | ✅ | ✅ |
name |
✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
phone |
✅ | ✅ | ✅ | ✅ | ➖ | ✅ | ✅ |
status |
✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
website |
➖ | ✅ | ➖ | ✅ | ➖ | ✅ | ✅ |
source_create_time |
➖ | ✅ | ✅ | ➖ | ✅ | ✅ | ➖ |
source_update_time |
➖ | ✅ | ✅ | ➖ | ✅ | ➖ | ➖ |
✅ Supported and mapped
🟡 Partially mapped, not exact match
🔜 Launching soon
➖ Not supported in source system
A Lead represents a prospect or sales opportunity.
id | string <uuid> The UUID of the Lead assigned by Agave. |
source_id | string The ID of the Lead in the Source System. |
object (Address) | |
customer_id | string <uuid> The UUID assigned by Agave of the Customer. |
status | string The status of the Lead. |
source_create_time | string <date-time> The datetime the Lead was created. |
source_update_time | string <date-time> The datetime the Lead was last updated. |
{- "id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
- "source_id": "12345",
- "address": {
- "street_1": "123 Main Street",
- "street_2": "Unit 1",
- "city": "AnyTown",
- "state": "California",
- "country": "The United States of America",
- "postal_code": "19703"
}, - "customer_id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
- "status": "Active",
- "source_create_time": "2022-01-01T00:00:00Z",
- "source_update_time": "2022-01-01T00:00:00Z"
}
Supported fields in each Source System:
Field | Salesforce | ServiceTitan |
---|---|---|
address |
🔜 | ✅ |
contact |
🔜 | ✅ |
customer |
🔜 | ✅ |
description |
🔜 | ✅ |
industry |
🔜 | ➖ |
status |
🔜 | ✅ |
type |
🔜 | ✅ |
source_create_time |
🔜 | ✅ |
source_update_time |
🔜 | ✅ |
✅ Supported and mapped
🟡 Partially mapped, not exact match
🔜 Launching soon
➖ Not supported in source system
An Opportunity represents a pending deal.
id | string <uuid> The UUID of the Opportunity assigned by Agave. |
source_id | string The ID of the Opportunity in the Source System. |
amount | string The monetary amount of the Opportunity. |
close_date | string <date> The date the Opportunity was closed. |
contact_ids | Array of strings <uuid> (IdPropertyReadOnly) The UUID assigned by Agave of the Contact. |
creator_id | string <uuid> The UUID assigned by Agave of the Contact that created the Opportunity. |
customer_ids | Array of strings <uuid> (IdPropertyReadOnly) The UUID assigned by Agave of the Customer. |
description | string A description of the Opportunity. |
name | string The name of the Opportunity. |
probability | string The probability assigned to winning the Opportunity. |
stage | string The current stage of the Opportunity. |
status | string The current status of the Opportunity. |
type | string The type of Opportunity. |
source_create_time | string <date-time> The datetime the Opportunity was created in the Source System. |
source_update_time | string <date-time> The datetime the Opportunity was last updated in the Source System. |
{- "id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
- "source_id": "12345",
- "amount": "150000",
- "close_date": "2022-01-01",
- "contact_ids": [
- "ee9b53e7-f982-4be6-bc12-75f716d3ee94"
], - "creator_id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
- "customer_ids": [
- "ee9b53e7-f982-4be6-bc12-75f716d3ee94"
], - "description": "A new apartment building in South San Francisco.",
- "name": "123 Apartment Project",
- "probability": "10",
- "stage": "Qualification",
- "status": "Won",
- "type": "newbusiness",
- "source_create_time": "2022-01-01T00:00:00Z",
- "source_update_time": "2022-01-01T00:00:00Z"
}
Supported fields in each Source System:
Field | HubSpot | Salesforce |
---|---|---|
amount |
✅ | ✅ |
close_date |
✅ | ✅ |
creator_id |
✅ | ✅ |
customer_id |
✅ | ✅ |
description |
✅ | ✅ |
name |
✅ | ✅ |
probability |
✅ | ✅ |
stage |
✅ | ✅ |
status |
✅ | ✅ |
type |
✅ | ✅ |
source_create_time |
✅ | ✅ |
source_update_time |
✅ | ✅ |
✅ Supported and mapped
🟡 Partially mapped, not exact match
🔜 Launching soon
➖ Not supported in source system
A Files is a document (e.g. PDF, Word Document, image).
Supported Source Systems include:
- Aconex (read and write)
- Autodesk Build (read and write)
- BIM 360 (read and write)
- CompanyCam (read only)
- Dropbox (read and write)
- Egnyte (read only)
- Fieldwire (read and write)
- HubSpot (read and write)
- OneDrive (read and write)
- Pipedrive (read and write)
- PlanGrid (read and write)
- Procore (read and write)
- Sharepoint Online (read and write)
For details on the File data model and fields supported in each Source System, see link.
All Files
This endpoint retrieves a list of Files a Linked User can access.
Note: the header Project-ID is required for the following systems:
- Aconex
- Autodesk Build
- BIM 360
- PlanGrid
- Procore
Authorizations:
path Parameters
folder_id required | string <uuid> The UUID of the Folder assigned by Agave |
header Parameters
API-Version required | string This value specifies which Agave API version to use.
The current version is |
Include-Source-Data | boolean Default: false A flag denoting whether you would like to also return the raw data from a Source System. |
Project-Id | string <uuid> The UUID of the Project assigned by Agave. Depending on the endpoint and Source System, this may be required (see note above). |
Responses
Response samples
- 200
- 400
- 429
{- "data": [
- {
- "id": "string",
- "source_id": "12345",
- "creator_id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
- "file_version_id": "ee9b53e7-f982-4be6-bc12-75f716d3ee94",
- "file_version_source_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."
], - "size": 98765,
- "type": "Adobe Acrobat PDF",
- "version": "4",
- "source_create_time": "2022-01-01T00:00:00Z",
- "source_update_time": "2022-01-01T00:00:00Z",
- "source_data": {
- "content_type": "application/json",
- "data": {
- "@attributes": {
- "DocumentId": "12345"
}, - "DateApproved": [ ],
- "AsBuiltRequired": "false",
- "Attribute1": {
- "AttributeTypeNames": [ ]