Vendasta CRM API (gRPC gateway)
The CRM surface exposed through the gRPC reverse-proxy gateway: CRMService, CRMAssociationService, CRMCompanyService, CRMOpportunityService, CRMFieldSchemaService and CRMFieldSchemaCustomizationService. 53 operations covering contact, company, opportunity, association and schema management.
Vendasta CRM API (gRPC gateway) is one of 38 APIs that Vendasta publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include CRM, gRPC, Contacts, Companies, and Opportunities. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 53 operations across 53 paths, organized into 9 resource areas, and defines 98 schemas. It is described by OpenAPI 3.0.0, at version 0.157.0.
Requests are made against a single base URL, https://prod.apigateway.co/grpc.
53 operations
53 paths
98 schemas
53 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Vendasta CRM API (gRPC gateway) declares
1 security scheme
for authenticating requests.
It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 13 scopes.
Paths & Operations 53
Across 53 paths, the API surfaces 53 operations — 53 POST. They span 9 resource areas: CRMAssociationService, CRMCompanyService, CRMService, CRMCustomObjectTypeService, CRMCustomObjectService, CRMFieldSchemaCustomizationService, CRMFieldSchemaService, CRMOpportunityService, Pipelines. Each is listed below with its method, path, parameters, and response codes.
CRMAssociationService 6
POST
/v1/crm/association/create
Create Association
POST
/v1/crm/association/delete
Delete Association
POST
/v1/crm/association/field-options
List Association Field Options
POST
/v1/crm/association/get-multi
Get Multi Association
POST
/v1/crm/association/list
List Associations
POST
/v1/crm/association/update
Update Association
CRMCompanyService 6
POST
/v1/crm/company/create
Create Company
POST
/v1/crm/company/delete
Delete Company
POST
/v1/crm/company/field-options
List Company Field Options
POST
/v1/crm/company/get-multi
Get Multi Company
POST
/v1/crm/company/list
List Companies
POST
/v1/crm/company/update
Update Company
CRMService 6
POST
/v1/crm/contact/create
Create Contact
POST
/v1/crm/contact/delete
Delete Contact
POST
/v1/crm/contact/field-options
List Contact Field Options
POST
/v1/crm/contact/get-multi
Get Multi Contact
POST
/v1/crm/contact/list
List Contacts
POST
/v1/crm/contact/update
Update Contact
CRMCustomObjectTypeService 5
POST
/v1/crm/custom-object-type/create
Create Custom Object Type
POST
/v1/crm/custom-object-type/delete
Delete Custom Object Type
POST
/v1/crm/custom-object-type/get-multi
Get Multi Custom Object Type
POST
/v1/crm/custom-object-type/list
List Custom Object Types
POST
/v1/crm/custom-object-type/update
Update Custom Object Type
CRMCustomObjectService 9
POST
/v1/crm/custom-object/bulk-delete
Bulk Delete Custom Objects
POST
/v1/crm/custom-object/create
Create Custom Object
POST
/v1/crm/custom-object/delete
Delete Custom Object
POST
/v1/crm/custom-object/field-options
List Custom Object Field Options
POST
/v1/crm/custom-object/get-multi
Get Multi Custom Object
POST
/v1/crm/custom-object/list
List Custom Objects
POST
/v1/crm/custom-object/list-filters
List Custom Object Filters
POST
/v1/crm/custom-object/update
Update Custom Object
POST
/v1/crm/custom-object/validate
Validate Custom Object
CRMFieldSchemaCustomizationService 5
POST
/v1/crm/field-schema-customization/create
Create Field Schema Customization
POST
/v1/crm/field-schema-customization/delete
Delete Field Schema Customization
POST
/v1/crm/field-schema-customization/get-multi
Get Multi Field Schema Customization
POST
/v1/crm/field-schema-customization/list
List Field Schema Customization
POST
/v1/crm/field-schema-customization/update
Update Field Schema Customization
CRMFieldSchemaService 5
POST
/v1/crm/field-schema/archive
Archive Field Schema
POST
/v1/crm/field-schema/create
Create Field Schema
POST
/v1/crm/field-schema/get-multi
Get Multi Field Schema
POST
/v1/crm/field-schema/list
List Field Schema
POST
/v1/crm/field-schema/update
Update Field Schema
CRMOpportunityService 6
POST
/v1/crm/opportunity/create
Create Opportunity
POST
/v1/crm/opportunity/delete
Delete Opportunity
POST
/v1/crm/opportunity/field-options
List Opportunity Field Options
POST
/v1/crm/opportunity/get-multi
Get Multi Opportunity
POST
/v1/crm/opportunity/list
List Opportunities
POST
/v1/crm/opportunity/update
Update Opportunity
Pipelines 5
POST
/v1/crm/pipeline/create
Create Pipeline
POST
/v1/crm/pipeline/delete
Delete Pipeline
POST
/v1/crm/pipeline/get-multi
Get Multi Pipeline
POST
/v1/crm/pipeline/list
List Pipelines
POST
/v1/crm/pipeline/update
Update Pipeline
Schemas 98
The contract defines 98 schemas that model the data the API accepts and returns. The most detailed are v1FieldSchema (16 properties), v1FieldValue (12 properties), v1CrmObject (11 properties), v1Association (10 properties). Each schema is shown below with its type and property counts.
ValidateCrmObjectResponseUniquenessCheck
object
3 properties
ValidateCrmObjectResponseValidationErrorDetails
object
2 properties
ValidateCrmObjectResponseValidationErrorSeverity
string
crmv1FieldUniqueness
string
FieldUniqueness describes whether values in a field must be unique across a namespace's objects of the same type. It is surfaced read-only on FieldSchema; it c…
crmv1Tag
object
1 property
protobufAny
object
1 property
rpcStatus
object
3 properties
v1ArchiveFieldSchemaRequest
object
Request to archive a field schema. Archived schemas are hidden from default list responses and are not used when reading or writing CRM objects, but their hist…
4 properties
3 required
v1Association
object
Represents a directional link between two CRM objects, such as a contact-to-company or opportunity-to-contact relationship.
10 properties
v1BulkDeleteCrmObjectsRequest
object
Request to bulk-delete CRM objects matching the specified filters within a namespace.
4 properties
1 required
v1CreateAssociationRequest
object
Request to create a new association between two CRM objects within a namespace.
2 properties
2 required
v1CreateAssociationResponse
object
Response containing the identifier of the newly created association.
1 property
v1CreateCrmObjectRequest
object
Request to create a new CRM object (contact, company, opportunity, or custom object) within a namespace.
2 properties
2 required
v1CreateCrmObjectResponse
object
Response containing the identifier of the newly created CRM object.
1 property
v1CreateCustomObjectTypeRequest
object
Request to create a new custom object type within a namespace.
2 properties
2 required
v1CreateCustomObjectTypeResponse
object
Response containing the identifier of the newly created custom object type.
1 property
v1CreateFieldSchemaCustomizationRequest
object
Request to create a field schema customization, which restricts the allowed values for a specific field on a CRM object type within a namespace.
3 properties
3 required
v1CreateFieldSchemaRequest
object
Request to create a new custom field schema on a CRM object type within a namespace.
4 properties
3 required
v1CreateFieldSchemaResponse
object
Response containing the identifier of the newly created field schema.
1 property
v1CreatePipelineRequest
object
Request to create a new pipeline within a namespace.
1 property
1 required
v1CreatePipelineResponse
object
Response containing the identifier of the newly created pipeline.
1 property
v1CrmObject
object
Represents a CRM record such as a contact, company, opportunity, or custom object. Contains the object's field values, metadata, and system-managed timestamps.
11 properties
v1CrmObjectSearch
object
1 property
v1Currency
object
2 properties
v1CustomObjectType
object
Defines a partner-created custom object type in the CRM, including its display names and system-managed timestamps.
7 properties
v1DateDefault
string
v1DeleteAssociationRequest
object
Request to delete an association between CRM objects within a namespace.
2 properties
2 required
v1DeleteCrmObjectRequest
object
Request to soft-delete a CRM object within a namespace.
2 properties
2 required
v1DeleteCustomObjectTypeRequest
object
Request to delete a custom object type within a namespace.
2 properties
2 required
v1DeleteFieldSchemaCustomizationRequest
object
Request to delete a field schema customization for a specific field on a CRM object type within a namespace.
3 properties
3 required
v1DeletePipelineRequest
object
Request to delete a pipeline within a namespace.
2 properties
2 required
v1DropdownOption
object
2 properties
v1FieldSchema
object
Defines a field on a CRM object type. Field schemas describe the type, label, and validation rules for both built-in fields (provided by Vendasta) and partner-…
16 properties
v1FieldSchemaCustomization
object
6 properties
v1FieldType
string
- FIELDTYPEDROPDOWN: FIELDTYPEDROPDOWN is passed as a string in the fieldvalue - FIELDTYPECURRENCY: FIELDTYPECURRENCY is passed as a Currency message containin…
v1FieldValue
object
FieldValue represents one of the fields of a crm object (Contact, Company, etc...) On Create/Update we need the fieldid or externalid filled, with the fieldid…
12 properties
v1Filter
object
4 properties
v1FilterDefinition
object
Describes an available filter for searching CRM objects, including its type and supported operators.
5 properties
v1FilterGroup
object
2 properties
v1FilterGroupOperator
string
v1FilterOperator
string
v1FilterType
string
v1FilterValue
object
7 properties
v1Geopoint
object
2 properties
v1GetMultiAssociationRequest
object
Request to retrieve multiple associations by their IDs within a namespace.
2 properties
2 required
v1GetMultiAssociationResponse
object
Response containing the requested associations and per-ID status codes.
2 properties
v1GetMultiCrmObjectRequest
object
Request to retrieve multiple CRM objects by their IDs within a namespace.
4 properties
2 required
v1GetMultiCrmObjectResponse
object
Response containing the requested CRM objects and their field schemas.
2 properties
v1GetMultiCustomObjectTypeRequest
object
Request to retrieve multiple custom object types by their IDs within a namespace.
3 properties
2 required
v1GetMultiCustomObjectTypeResponse
object
Response containing the requested custom object types.
1 property
v1GetMultiFieldSchemaCustomizationRequest
object
Request to retrieve field schema customizations for the specified fields on a CRM object type within a namespace.
3 properties
3 required
v1GetMultiFieldSchemaCustomizationResponse
object
Response containing the requested field schema customizations.
1 property
v1GetMultiFieldSchemaRequest
object
Request to retrieve multiple field schemas by ID for a CRM object type within a namespace.
5 properties
3 required
v1GetMultiFieldSchemaResponse
object
Response containing the requested field schemas.
1 property
v1GetMultiPipelineRequest
object
Request to retrieve multiple pipelines by their IDs within a namespace.
2 properties
2 required
v1GetMultiPipelineResponse
object
Response containing the requested pipelines.
1 property
v1ListAssociationFieldOptionsRequest
object
Request to list valid values for a field on associations of a given type.
5 properties
3 required
v1ListAssociationFieldOptionsResponse
object
Response containing the valid values for the requested association field.
1 property
v1ListAssociationsRequest
object
Request to list associations within a namespace, with optional filtering and pagination.
3 properties
1 required
v1ListAssociationsResponse
object
Response containing a page of associations matching the request criteria.
3 properties
v1ListCrmObjectsRequest
object
Request to list CRM objects within a namespace, with optional filtering, sorting, and pagination.
7 properties
1 required
v1ListCrmObjectsResponse
object
Response containing a page of CRM objects matching the request criteria.
2 properties
v1ListCustomObjectTypesRequest
object
Request to list all custom object types within a namespace.
1 property
1 required
v1ListCustomObjectTypesResponse
object
Response containing all custom object types in the namespace.
1 property
v1ListFieldOptionsRequest
object
Request to list the valid values for a string-based field type on a CRM object.
5 properties
2 required
v1ListFieldOptionsResponse
object
Response containing the valid string values for the requested field.
1 property
v1ListFieldSchemaCustomizationRequest
object
Request to list field schema customizations within a namespace, optionally filtered by CRM object type.
3 properties
1 required
v1ListFieldSchemaCustomizationResponse
object
Response containing a page of field schema customizations matching the request criteria.
2 properties
v1ListFieldSchemaRequest
object
Request to list field schemas for a CRM object type within a namespace, optionally filtered by subtype, namespace, archive status, or search term.
7 properties
1 required
v1ListFieldSchemaRequestFilters
object
2 properties
v1ListFieldSchemaResponse
object
Response containing a page of field schemas that match the request criteria.
2 properties
v1ListFiltersRequest
object
Request to list the available filters for searching CRM objects within a namespace.
5 properties
1 required
v1ListFiltersResponse
object
Response containing the available filter definitions for searching CRM objects.
2 properties
v1ListOptions
object
3 properties
1 required
v1ListPipelinesRequest
object
Request to list pipelines within a namespace, optionally filtered by object type.
1 property
1 required
v1ListPipelinesResponse
object
Response containing the pipelines matching the request criteria.
1 property
v1ObjectProjectionFilter
object
4 properties
v1Phone
object
3 properties
v1PhoneFields
object
4 properties
v1Pipeline
object
A structured representation of a sales or business process, tracking CRM objects through defined stages from start to finish.
6 properties
4 required
v1ProjectionFilterType
string
v1SortBy
object
2 properties
v1SortDirection
string
v1Stage
object
Represents a single stage within a pipeline, including the filter criteria that determine object membership and mutations applied on stage entry.
4 properties
2 required
v1StringList
object
1 property
v1UpdateAssociationRequest
object
Request to update the tags on an existing association.
3 properties
2 required
v1UpdateCrmObjectRequest
object
Request to update an existing CRM object within a namespace. Use the field mask to specify which fields to update.
3 properties
2 required
v1UpdateCustomObjectTypeRequest
object
Request to update an existing custom object type within a namespace.
3 properties
2 required
v1UpdateFieldSchemaCustomizationRequest
object
Request to update an existing field schema customization on a CRM object type within a namespace.
4 properties
3 required
v1UpdateFieldSchemaRequest
object
Request to update an existing custom field schema. Only fields named in the field mask are modified. The CRM object type and subtype of an existing schema cann…
5 properties
4 required
v1UpdatePipelineRequest
object
Request to update an existing pipeline. Use the field mask to specify which fields to update.
2 properties
1 required
v1ValidateCrmObjectRequest
object
Request to validate the data on a CRM object before creating or updating it.
2 properties
2 required
v1ValidateCrmObjectResponse
object
Response containing any validation errors found on the submitted CRM object.
1 property
v1ValidateCrmObjectResponseFieldUniqueness
string
v1ValidateCrmObjectResponseValidationError
object
4 properties
vendastatypesFieldMask
object
paths: "f.a" paths: "f.b.d" Here f represents a field in some root message, a and b fields in the message found in f, and d a field found in the message in f.b…
1 property
vendastatypesPagedRequestOptions
object
2 properties
vendastatypesPagedResponseMetadata
object
3 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Vendasta 12
Other APIs Vendasta publishes across the network.
Vendasta account API
Vendasta activity API
Vendasta change_spend API
Vendasta customer API
Vendasta executive_report API
Vendasta marketplace_app API
Vendasta oauth API
Vendasta user API
Vendasta Platform REST API
Vendasta SCIM 2.0 User Management API
Vendasta CRM REST API
Vendasta Local SEO REST API
#CRM#gRPC#Contacts#Companies#Opportunities#Schemas
Where this information came from
This is an independent, third-party profile of Vendasta CRM API (gRPC gateway), published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.