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
Convoy

Convoy Endpoints API

Endpoint related APIs

Documentation Provider Profile APIs.io OpenAPI GitHub

Convoy Endpoints API is one of 11 APIs that Convoy publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 8 JSON Schema definitions.

The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, authentication docs, a getting-started guide, a GitHub repository, and 8 JSON Schemas.

This API exposes 9 operations across 6 paths, and defines 29 schemas. It is described by OpenAPI 3.2.0, at version 26.3.5.

Requests are made against 2 base URLs: https://us.getconvoy.cloud/api, https://eu.getconvoy.cloud/api.

9 operations 6 paths 29 schemas 1 DELETE2 GET3 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
26.3.5
Base URL
https://us.getconvoy.cloud/api
Authentication
API Key
Contact
Convoy Support
License
Mozilla Public License 2.0
Terms of Service
View terms
Resource Areas
1

Authentication & Security 1

Convoy Endpoints API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (ApiKeyAuth).

Paths & Operations 9

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

Endpoints 9

Endpoint related APIs

GET
/v1/projects/{projectID}/endpoints
List All Endpoints
GetEndpoints 8 params → 200400401404
POST
/v1/projects/{projectID}/endpoints
Create an Endpoint
CreateEndpoint 1 param body → 201400401404
POST
/v1/projects/{projectID}/endpoints/oauth2/test
Test OAuth2 Connection
TestOAuth2Connection 1 param body → 200400401404
DELETE
/v1/projects/{projectID}/endpoints/{endpointID}
Delete Endpoint
DeleteEndpoint 2 params → 200400401404
GET
/v1/projects/{projectID}/endpoints/{endpointID}
Retrieve Endpoint
GetEndpoint 2 params → 200400401404
PUT
/v1/projects/{projectID}/endpoints/{endpointID}
Update an Endpoint
UpdateEndpoint 2 params body → 202400401404
POST
/v1/projects/{projectID}/endpoints/{endpointID}/activate
Activate Endpoint
ActivateEndpoint 2 params → 202400401404
PUT
/v1/projects/{projectID}/endpoints/{endpointID}/expire_secret
Roll Endpoint Secret
ExpireSecret 2 params body → 200400401404
PUT
/v1/projects/{projectID}/endpoints/{endpointID}/pause
Pause Endpoint
PauseEndpoint 2 params → 202400401404

Schemas 29

The contract defines 29 schemas that model the data the API accepts and returns. The most detailed are models.EndpointResponse (22 properties), models.CreateEndpoint (16 properties), models.UpdateEndpoint (15 properties), datastore.OAuth2 (13 properties). Each schema is shown below with its type and property counts.

models.ApiKey
object
2 properties 2 required
models.OAuth2
object
13 properties
datastore.EndpointAuthenticationType
string
models.OAuth2SigningKey
object
13 properties
models.PagedResponse
object
2 properties
models.UpdateEndpoint
object
15 properties
datastore.PaginationData
object
5 properties
models.TestOAuth2Response
object
6 properties
datastore.BasicAuth
object
2 properties
models.EndpointAuthentication
object
4 properties
datastore.EndpointAuthentication
object
4 properties
models.EndpointResponse
object
22 properties
handlers.Stub
object
models.BasicAuth
object
2 properties 2 required
datastore.EndpointStatus
string
datastore.ApiKey
object
2 properties
models.CreateEndpoint
object
16 properties
models.MtlsClientCert
object
2 properties
models.ExpireSecret
object
2 properties
models.OAuth2FieldMapping
object
3 properties
util.ServerResponse
object
2 properties
datastore.OAuth2
object
13 properties
datastore.OAuth2SigningKey
object
13 properties
datastore.MtlsClientCert
object
2 properties
datastore.OAuth2ExpiryTimeUnit
string
datastore.OAuth2FieldMapping
object
3 properties
models.TestOAuth2Request
object
1 property
datastore.OAuth2AuthenticationType
string
datastore.Secret
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

convoy-endpoints-api-openapi.yml Raw ↑

Other APIs Convoy publishes across the network.

Convoy Delivery Attempts API
AE Profile APIs.io
Convoy Event Deliveries API
AE Profile APIs.io
Convoy Events API
AE Profile APIs.io
Convoy EventTypes API
AE Profile APIs.io
Convoy Filters API
AE Profile APIs.io
Convoy Meta Events API
AE Profile APIs.io
Convoy Onboard API
AE Profile APIs.io
Convoy Portal Links API
AE Profile APIs.io
Convoy Sources API
AE Profile APIs.io
Convoy Subscriptions API
AE Profile APIs.io
← Back to C APIs
API Details
ID
convoy:convoy-endpoints-api
Base URL
https://us.getconvoy.cloud/api
Docs
https://getconvoy.io/docs/api-reference/welcome
Provider
Convoy
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=convoy-endpoints-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/convoy-endpoints-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 Convoy Endpoints 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.