Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zendesk Sell Leads API

Pre-qualified sales prospects.

Zendesk Sell Leads API is one of 4 APIs that Zendesk Sell publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 6 operations across 3 paths, and defines 1 schema. It is described by OpenAPI 3.1.0, at version 2.0.

Requests are made against a single base URL, https://api.getbase.com.

6 operations 3 paths 1 schemas 1 DELETE2 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.0
Base URL
https://api.getbase.com
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Zendesk Sell Leads API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 2 scopes. By default, every request must be authenticated.

  • oauth2 — OAuth 2.0 (authorization code, implicit, password, and refresh token grants).

Paths & Operations 6

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

Leads 6

Pre-qualified sales prospects.

GET
/v2/leads
List leads
listLeads 12 params → 200
POST
/v2/leads
Create a lead
createLead body → 200
GET
/v2/leads/{id}
Retrieve a lead
getLead 1 param → 200
PUT
/v2/leads/{id}
Update a lead
updateLead 1 param body → 200
DELETE
/v2/leads/{id}
Delete a lead
deleteLead 1 param → 204
POST
/v2/leads/upsert
Upsert a lead
upsertLead body → 200

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is Lead (11 properties). Each schema is shown below with its type and property counts.

Lead
object
11 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zendesk-sell-leads-api-openapi.yml Raw ↑

Other APIs Zendesk Sell publishes across the network.

Zendesk Sell (Sales CRM) API
Zendesk Sell Contacts API
Zendesk Sell Deals API