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

Convert API Keys API

API Keys are used to authenticate requests from Server side applications that access this API

Convert API Keys API is one of 33 APIs that Convert publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

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

Requests are made against 3 base URLs: https://api.convert.com/api/v2, https://apidev.convert.com/api/v2, http://apidev.convert.com:5000/api/v2.

3 operations 3 paths 9 schemas 1 DELETE1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0.0
Base URL
https://api.convert.com/api/v2
Authentication
API Key, HTTP Bearer, API Key
Resource Areas
1

Authentication & Security 3

Convert API Keys API declares 3 security schemes for authenticating requests. An API key is passed in the header as Authorization (requestSigning). It accepts HTTP bearer tokens (secretKey). An API key is passed in the cookie as sid (cookieAuthentication).

  • requestSigning — See [API Key Authentication](tag/API-KEY-Authentication) for more information.
  • secretKey — See [API Key Authentication](tag/API-KEY-Authentication) for more information.
  • cookieAuthentication — Cookie authentication is used against Convert's own IdentityProvider or third party identity providers and is described more in the "[Cookie Authentication](ta…

Paths & Operations 3

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

API Keys 3

API Keys are used to authenticate requests from Server side applications that access this API

GET
/accounts/{account_id}/api-keys
List API keys for an account
getApiKeysList 1 param → 200
POST
/accounts/{account_id}/api-keys/add
Create a new API key for an account
createApiKey 1 param body → 201default
DELETE
/accounts/{account_id}/api-keys/{key_id}/delete
Delete an API key
deleteApiKey 2 params → 200default

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are ApiKey (6 properties), ErrorData (3 properties), SuccessData (2 properties), ApiKeysListResponse (1 property). Each schema is shown below with its type and property counts.

ApiKeyRole
The role assigned to this API key, which determines its permissions. Must have equal or lower permissions than the creator's role when creating. If not specifi…
CreateApiKeyRequestData
ApiKeysListResponse
object
Response containing a list of API keys defined for a specific account, used for server-to-server authentication.
1 property
ApiKeysList
array
A list of API key objects.
AccessRoleNamesNoOwner
string
Access roles that can be assigned to collaborators or API keys (excludes the 'owner' role, which is typically unique to the account creator).
ApiKey
object
Defines an API key used for authenticating server-side requests to the Convert API.
6 properties
SuccessData
object
2 properties
ErrorData
object
3 properties
ApiKeyAuthTypes
string
The authentication type for this API key: - requestSigning: Each request must be signed with the key and a hash sent in the header (most secure) - secretKey: A…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

convert-api-keys-api-openapi.yml Raw ↑

Other APIs Convert publishes across the network.

Convert Experiences REST API v2
Convert Accounts API
Convert AI content API
Convert Audiences API
Convert Bulk API
Convert Cdn Images API
Convert Collaborators API
Convert Cookie Authentication API
Convert Domains API
Convert Experience Sections API
Convert Experience Variations API
Convert Experiences API
Where this information came from

This is an independent, third-party profile of Convert API Keys 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.