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

Z League Leads API

The Leads API from Z League — 2 operation(s) for leads.

Z League Leads API is one of 2 APIs that Z League publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Leads. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, a getting-started guide, authentication docs, and an AsyncAPI specification.

This API exposes 3 operations across 2 paths, and defines 13 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, https://app.gomega.ai.

3 operations 2 paths 13 schemas 1 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://app.gomega.ai
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Z League Leads API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Admin-issued Personal Access Token, e.g. Authorization: Bearer mega . The key carries scopes (publicapi:leads:read, publicapi:leads:write, publicapi:webhooks:m…

Paths & Operations 3

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

Leads 3
GET
/api/agents/crm/leads
List / search leads
listLeads 13 params → 200400401403429
POST
/api/agents/crm/leads
Create a single lead
createLead 2 params body → 201400401403409429
POST
/api/agents/crm/leads/bulk
Bulk create / merge leads
bulkImportLeads 2 params body → 200400401403409429

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are Lead (17 properties), BulkLeadRow (10 properties), LeadCreateRequest (7 properties), BulkRowResult (6 properties). Each schema is shown below with its type and property counts.

Owner
objectnull
3 properties
LeadListResponse
object
5 properties 5 required
BulkLeadRow
object
At least one of contactname, contactphone, contactemail is required.
10 properties
BulkRowResult
object
6 properties 5 required
BulkImportRequest
object
3 properties 1 required
SourcePlatform
string
SourceType
string
Stage
object
4 properties
BulkImportResponse
object
4 properties 4 required
Error
object
1 property 1 required
Lead
object
17 properties 7 required
LeadCreateRequest
object
At least one of contactname, contactphone, contactemail is required.
7 properties
CustomFieldMap
object
Map of custom-field slug to a scalar value (string | number | boolean | null).

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

z-league-leads-api-openapi.yml Raw ↑

Other APIs Z League publishes across the network.

Z League Webhooks API