Convoy Portal Links API
Portal Links related APIs
Convoy Portal Links 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.
Tagged areas include Portal Links. 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 6 operations across 4 paths, and defines 21 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.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Convoy Portal Links API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as Authorization (ApiKeyAuth).
Paths & Operations 6
Across 4 paths, the API surfaces 6 operations — 3 GET, 1 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.
Portal Links related APIs
Schemas 21
The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are datastore.Endpoint (22 properties), datastore.PortalLinkResponse (15 properties), datastore.OAuth2 (13 properties), datastore.OAuth2SigningKey (13 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Convoy 10
Other APIs Convoy publishes across the network.
This is an independent, third-party profile of Convoy Portal Links 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.