How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Vendasta CRM Field Schema Service API

The CRMFieldSchemaService API from Vendasta — 5 operation(s) for crmfieldschemaservice.

Vendasta CRM Field Schema Service API is one of 87 APIs that Vendasta publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include CRMFieldSchemaService. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 5 operations across 5 paths, and defines 18 schemas. It is described by OpenAPI 3.2.0, at version 0.157.0.

Requests are made against a single base URL, https://prod.apigateway.co/grpc.

5 operations 5 paths 18 schemas 5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
0.157.0
Base URL
https://developers.vendasta.com/api/v1
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Vendasta CRM Field Schema Service API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 13 scopes.

Paths & Operations 5

Across 5 paths, the API surfaces 5 operations — 5 POST. Each is listed below with its method, path, parameters, and response codes.

CRMFieldSchemaService 5
POST
/v1/crm/field-schema/archive
Archive Field Schema
CRMFieldSchemaService_ArchiveFieldSchema body → 200default
POST
/v1/crm/field-schema/create
Create Field Schema
CRMFieldSchemaService_CreateFieldSchema body → 200default
POST
/v1/crm/field-schema/get-multi
Get Multi Field Schema
CRMFieldSchemaService_GetMultiFieldSchema body → 200default
POST
/v1/crm/field-schema/list
List Field Schema
CRMFieldSchemaService_ListFieldSchema body → 200default
POST
/v1/crm/field-schema/update
Update Field Schema
CRMFieldSchemaService_UpdateFieldSchema body → 200default

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are v1FieldSchema (16 properties), v1ListFieldSchemaRequest (7 properties), v1GetMultiFieldSchemaRequest (5 properties), v1UpdateFieldSchemaRequest (5 properties). Each schema is shown below with its type and property counts.

rpcStatus
object
3 properties
vendastatypesPagedRequestOptions
object
2 properties
v1CreateFieldSchemaRequest
object
Request to create a new custom field schema 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
v1GetMultiFieldSchemaResponse
object
Response containing the requested field schemas.
1 property
v1CreateFieldSchemaResponse
object
Response containing the identifier of the newly created field schema.
1 property
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…
v1ListFieldSchemaResponse
object
Response containing a page of field schemas that match 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
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
v1FieldType
string
- FIELDTYPEDROPDOWN: FIELDTYPEDROPDOWN is passed as a string in the fieldvalue - FIELDTYPECURRENCY: FIELDTYPECURRENCY is passed as a Currency message containin…
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
v1GetMultiFieldSchemaRequest
object
Request to retrieve multiple field schemas by ID for a CRM object type within a namespace.
5 properties 3 required
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
v1DropdownOption
object
2 properties
vendastatypesPagedResponseMetadata
object
3 properties
protobufAny
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vendasta-crmfieldschemaservice-api-openapi.yml Raw ↑

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 Account Stats API
Vendasta Analytics Service API
Vendasta Assistants API
Vendasta Automation Runs API
Where this information came from

This is an independent, third-party profile of Vendasta CRM Field Schema Service API, 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.