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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Vendasta

Vendasta CRM REST API

The CRM REST API for contacts, companies, opportunities, associations and custom objects, exposed as generic JSON:API resource operations under /org. Vendasta names the CRM API as the one Platform surface still under active development, and as the replacement for the deprecated Customer List API.

Documentation Provider Profile APIs.io OpenAPI GitHub

Vendasta CRM REST API is one of 38 APIs that Vendasta publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include CRM, Contacts, Companies, Opportunities, and JSON:API. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 8 operations across 5 paths, and defines 13 schemas. It is described by OpenAPI 3.1.0, at version 1.0.

Requests are made against 4 base URLs: https://prod.apigateway.co/org, https://demo.apigateway.co/org, http://localhost:11001/org, {local}/org.

8 operations 5 paths 13 schemas 1 DELETE3 GET2 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0
Base URL
https://prod.apigateway.co/org
Authentication
OAuth 2.0, OAuth 2.0
Resource Areas
1

Authentication & Security 2

Vendasta CRM REST API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (OAuth2Demo) using the authorizationCode flow, exposing 1 scope. It supports OAuth 2.0 (OAuth2Prod) using the authorizationCode flow, exposing 1 scope. By default, every request must be authenticated.

Paths & Operations 8

Across 5 paths, the API surfaces 8 operations — 1 DELETE, 3 GET, 2 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Resource Operations 8

Endpoints related to Resource Operations

GET
/{namespace}/{resourceTypeCode}/meta/fields
Get field schema
ListFieldSchema 2 params → 200404
GET
/{namespace}/{resourceTypeCode}/meta/fields/{fieldId}/options
Get field options
GetFieldOptions 5 params → 200400
PATCH
/{namespace}/{resourceTypeCode}
Upsert CRM Record
UpsertCrmRecord 2 params body → 200400
POST
/{namespace}/{resourceTypeCode}
Create CRM Record
CreateCrmRecord 2 params → 200400
GET
/{namespace}/{resourceTypeCode}/{id}
Get CRM Record
GetCrmRecord 3 params → 200
DELETE
/{namespace}/{resourceTypeCode}/{id}
Delete CRM Record
DeleteCrmRecord 3 params → 200400
PATCH
/{namespace}/{resourceTypeCode}/{id}
Update CRM Record
UpdateCrmRecord 3 params body → 200400
POST
/list/{namespace}/{resourceTypeCode}
List CRM Records
ListCrmRecords 2 params body → 200400

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are CRMCompany (106 properties), CRMActivity (83 properties), CRMContact (71 properties), CRMMeetingActivity (36 properties). Each schema is shown below with its type and property counts.

CRMContact
object
CRM Contact Field Schema for AG-L56V52BMMW
71 properties
CRMActivity
object
The CRM Activity Field Schema combines the fields from all of the activity sub types
83 properties
CRMCallActivity
object
CRM Call Field Schema for AG-L56V52BMMW
27 properties
CRMCommunicationActivity
object
CRM Communication Field Schema for AG-L56V52BMMW
26 properties
CRMCompany
object
CRM Company Field Schema for AG-L56V52BMMW
106 properties
CRMEmailActivity
object
CRM Email Field Schema for AG-L56V52BMMW
26 properties
CRMMeetingActivity
object
CRM Meeting Field Schema for AG-L56V52BMMW
36 properties
CRMNoteActivity
object
CRM Note Field Schema for AG-L56V52BMMW
19 properties
CRMOpportunityChangeActivity
object
CRM OpportunityChange Field Schema for AG-L56V52BMMW
24 properties
CRMRecordChangeActivity
object
CRM RecordChange Field Schema for AG-L56V52BMMW
21 properties
CRMTaskActivity
object
CRM Task Field Schema for AG-L56V52BMMW
23 properties
CRMCustomObject
object
CRM Custom Object Field Schema
6 properties
CRMObject

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vendasta-crm-rest-openapi.json Raw ↑

Other APIs Vendasta publishes across the network.

Vendasta account API
AE Profile APIs.io
Vendasta activity API
AE Profile APIs.io
Vendasta change_spend API
AE Profile APIs.io
Vendasta customer API
AE Profile APIs.io
Vendasta executive_report API
AE Profile APIs.io
Vendasta marketplace_app API
AE Profile APIs.io
Vendasta oauth API
AE Profile APIs.io
Vendasta user API
AE Profile APIs.io
Vendasta Platform REST API
AE Profile APIs.io
Vendasta SCIM 2.0 User Management API
AE Profile APIs.io
Vendasta CRM API (gRPC gateway)
AE Profile APIs.io
Vendasta Local SEO REST API
AE Profile APIs.io
#CRM#Contacts#Companies#Opportunities#JSON:API
← Back to V APIs
API Details
ID
vendasta:vendasta-crm-rest-api
Base URL
https://prod.apigateway.co/org
Docs
https://developers.vendasta.com/platform
Provider
Vendasta
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=vendasta-crm-rest-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/vendasta-crm-rest-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

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