BusinessApp.io – Lead capture & customer mgmt for small business

Create Association

Create Association Creates a directional association between two CRM objects. The association type must be one of the fixed values with the correct direction (see the association type field description). Creating a duplicate association (same type, fromId, and toId) returns an ALREADY_EXISTS error (HTTP 409). Request to create a new association between two CRM objects within a namespace. Requires a valid Vendasta IAM bearer token.

List Associations

List Associations Lists associations in a namespace. Use this to discover a record's relationships; for example an opportunity related company or contact is represented only as an association, not as a field on the opportunity. Request to list associations within a namespace, with optional filtering and pagination. Requires a valid Vendasta IAM bearer token.

Create Company

Create Company Request to create a new CRM object (contact, company, opportunity, or custom object) within a namespace. Requires a valid Vendasta IAM bearer token.

Get Multi Company

Get Multi Company Request to retrieve multiple CRM objects by their IDs within a namespace. Requires a valid Vendasta IAM bearer token.

List Companies

List Companies Request to list CRM objects within a namespace, with optional filtering, sorting, and pagination. Requires a valid Vendasta IAM bearer token.

Update Company

Update Company Request to update an existing CRM object within a namespace. Use the field mask to specify which fields to update. Requires a valid Vendasta IAM bearer token.

List Field Schema

List Field Schema Request to list field schemas for a CRM object type within a namespace, optionally filtered by subtype, namespace, archive status, or search term. Requires a valid Vendasta IAM bearer token.

Create Opportunity

Create Opportunity Requires the standard__opportunity_pipeline_id field (get a valid pipeline id from the List Pipelines endpoint) and standard__opportunity_name. The opportunity stage (standard__opportunity_calculated_stage_id) cannot be set directly; it is calculated from the opportunity field values. To place a deal in a stage, set standard__opportunity_probability (a float from 0 to 1) so the opportunity matches that stage filter (see the pipeline stages); standard__opportunity_status is rea

Get Multi Opportunity

Get Multi Opportunity Retrieves opportunities by id, including their field schemas. An opportunity related company and contact are associations, not fields, so use the association endpoints to resolve them. Request to retrieve multiple CRM objects by their IDs within a namespace. Requires a valid Vendasta IAM bearer token.

List Opportunities

List Opportunities Lists opportunities in a namespace with optional filtering, sorting, and pagination. An opportunity related company and contact are not fields on the opportunity; they are modeled as associations, so use the association endpoints to find them. Request to list CRM objects within a namespace, with optional filtering, sorting, and pagination. Requires a valid Vendasta IAM bearer token.

Update Opportunity

Update Opportunity The opportunity stage is calculated, not settable: to move an opportunity to another stage set standard__opportunity_probability (plus any other fields the target stage filter tests) so it matches the target stage filter (see the pipeline stages), and the calculated stage updates automatically. Send field_mask with the specific fields.<fieldId> paths being changed, and only those fields are touched — name and pipeline id need not be resent. Omitting field_mask replaces the who

Create Contact

Create Contact Request to create a new CRM object (contact, company, opportunity, or custom object) within a namespace. Requires a valid Vendasta IAM bearer token.

Get Multi Contact

Get Multi Contact Request to retrieve multiple CRM objects by their IDs within a namespace. Requires a valid Vendasta IAM bearer token.

List Contacts

List Contacts Request to list CRM objects within a namespace, with optional filtering, sorting, and pagination. Requires a valid Vendasta IAM bearer token.

Update Contact

Update Contact Request to update an existing CRM object within a namespace. Use the field mask to specify which fields to update. Requires a valid Vendasta IAM bearer token.

Create Pipeline

Create Pipeline Creates a pipeline that drives stage calculation for its object type (usually Opportunity). Provide stages in order; stageId should be omitted, it is assigned by the server on create. Each stage needs a name, a filterGroup with at least one filter and a valid filterGroupOperator, and mutations. A stage filterGroup determines membership from the object field values (for opportunities, typically standard__opportunity_status and standard__opportunity_probability, for example status

List Pipelines

List Pipelines Lists pipelines and their stages. Each stage filterGroup defines which objects fall in that stage (for opportunities, conditions over status and probability). Use this to determine which field values place an opportunity in a given stage, and to obtain a valid pipeline id for creating an opportunity. Wrap all arguments in a listOptions object; namespace goes inside listOptions (unlike the other list endpoints). Request to list pipelines within a namespace, optionally filtered by o

Get Vendasta Doc

Fetch the body of a Vendasta documentation page. Takes a file_id from search_docs results and returns that document's body rather than the search excerpt. Documents over 512 KB are truncated, and the truncation is marked in the returned text. A file_id is a signed token produced by search_docs; no other form of identifier is accepted. Input: file_id (string, required) — file_id from a search_docs result

Search Vendasta Docs

Search Vendasta's published documentation. Semantic search over Vendasta's documentation — platform and API reference, CRM concepts, authentication, and product guides. Returns short excerpts rather than whole documents. Inputs: query (string, required) — natural-language description of the topic limit (integer, optional, 1–10, default 5) — max results to return Returns a JSON object with a "results" array ordered by relevance, each with: title — human-readable document name (whe