find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/convert-oauth-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Convert O Auth API
  description: Move your app forward with the Convert API.
  version: 2.0.0
servers:
- url: https://api.convert.com/api/v2
  description: Live API server
- url: https://apidev.convert.com/api/v2
  description: DEV API server
- url: http://apidev.convert.com:5000/api/v2
  description: DEV mocked API server
tags:
- name: OAuth
  description: Manage OAuth clients and authorized sessions.
paths:
  /auth/oauth/clients:
    get:
      operationId: listOauthClients
      summary: List OAuth clients
      description: Cookie-authenticated endpoint that lists OAuth clients for the current user.
      tags:
      - OAuth
      responses:
        '200':
          $ref: '#/components/responses/OAuthClientsListResponse'
        default:
          $ref: '#/components/responses/ErrorResponse'
    post:
      operationId: createOauthClient
      summary: Create an OAuth client
      description: Cookie-authenticated endpoint to register a new OAuth client.
      tags:
      - OAuth
      requestBody:
        $ref: '#/components/requestBodies/OAuthCreateClientRequest'
      responses:
        '200':
          $ref: '#/components/responses/OAuthClientResponse'
        default:
          $ref: '#/components/responses/ErrorResponse'
  /auth/oauth/clients/{id}/update:
    post:
      operationId: updateOauthClient
      summary: Update an OAuth client
      description: Cookie-authenticated endpoint to update an existing OAuth client.
      tags:
      - OAuth
      parameters:
      - name: id
        in: path
        required: true
        description: OAuth client id.
        schema:
          type: string
      requestBody:
        $ref: '#/components/requestBodies/OAuthUpdateClientRequest'
      responses:
        '200':
          $ref: '#/components/responses/OAuthClientResponse'
        default:
          $ref: '#/components/responses/ErrorResponse'
  /auth/oauth/clients/{client_id}:
    delete:
      operationId: deleteOauthClient
      summary: Delete an OAuth client
      description: Cookie-authenticated endpoint to delete an OAuth client and all its sessions.
      tags:
      - OAuth
      parameters:
      - name: client_id
        in: path
        required: true
        description: OAuth client id.
        schema:
          type: string
      responses:
        '200':
          $ref: '#/components/responses/OAuthDeleteClientResponse'
        default:
          $ref: '#/components/responses/ErrorResponse'
components:
  schemas:
    ErrorData:
      type: object
      properties:
        code:
          type: integer
          format: int32
        message:
          oneOf:
          - type: string
          - type: array
            items:
              type: string
        fields:
          oneOf:
          - type: string
          - type: array
            items:
              type: string
    OAuthCreateClientRequestData:
      type: object
      required:
      - name
      - callback_url
      - embedded
      properties:
        name:
          type: string
          maxLength: 120
        callback_url:
          type: string
          format: uri
        description:
          type: string
          maxLength: 500
        embedded:
          type: boolean
          default: false
          description: 'Enable this when the OAuth client is used by a third-party or embedded integration. An embedded client stays active even if the user who created it is later deleted, so integrations that depend on it continue to work.

            '
    OAuthUpdateClientRequestData:
      type: object
      properties:
        name:
          type: string
          maxLength: 120
        callback_url:
          type: string
          format: uri
        description:
          type: string
          maxLength: 500
        embedded:
          type: boolean
          description: 'Enable this when the OAuth client is used by a third-party or embedded integration. An embedded client stays active even if the user who created it is later deleted, so integrations that depend on it continue to work.

            '
    OAuthClientData:
      type: object
      required:
      - id
      - name
      - callback_url
      - embedded
      properties:
        id:
          type: string
          readOnly: true
        name:
          type: string
        callback_url:
          type: string
          format: uri
        description:
          type: string
        embedded:
          type: boolean
          description: 'Enable this when the OAuth client is used by a third-party or embedded integration. An embedded client stays active even if the user who created it is later deleted, so integrations that depend on it continue to work.

            '
        created_at:
          type: integer
    OAuthClientsListResponseData:
      type: object
      required:
      - data
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/OAuthClientData'
    OAuthClientResponseData:
      type: object
      required:
      - id
      - name
      - callback_url
      - embedded
      properties:
        id:
          type: string
        name:
          type: string
        callback_url:
          type: string
          format: uri
        description:
          type: string
        embedded:
          type: boolean
          description: 'Enable this when the OAuth client is used by a third-party or embedded integration. An embedded client stays active even if the user who created it is later deleted, so integrations that depend on it continue to work.

            '
        created_at:
          type: integer
    OAuthDeleteClientResponseData:
      type: object
      required:
      - code
      - message
      properties:
        code:
          type: integer
        message:
          type: string
  requestBodies:
    OAuthCreateClientRequest:
      required: true
      description: Creates a new OAuth client application.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/OAuthCreateClientRequestData'
    OAuthUpdateClientRequest:
      required: true
      description: Updates an existing OAuth client application.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/OAuthUpdateClientRequestData'
  responses:
    ErrorResponse:
      description: 'Indicates an error occurred while processing the request. The `code` provides an HTTP status code, `message` offers a human-readable explanation or an array of validation errors, and `fields` (if present) specifies which input fields were problematic.

        '
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorData'
    OAuthDeleteClientResponse:
      description: OAuth client deletion confirmation.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/OAuthDeleteClientResponseData'
    OAuthClientResponse:
      description: Single OAuth client.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/OAuthClientResponseData'
    OAuthClientsListResponse:
      description: List of OAuth clients for the current user.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/OAuthClientsListResponseData'
  securitySchemes:
    requestSigning:
      type: apiKey
      x-name-applicationId: Convert-Application-ID
      x-name-expire: Expire
      name: Authorization
      in: header
      description: 'See **[API Key Authentication](#tag/API-KEY-Authentication)** for more information.

        '
    secretKey:
      type: http
      scheme: bearer
      description: 'See **[API Key Authentication](#tag/API-KEY-Authentication)** for more information.

        '
    cookieAuthentication:
      type: apiKey
      in: cookie
      name: sid
      description: Cookie authentication is used against Convert's own IdentityProvider  or third party identity providers and is described more in the "[Cookie Authentication](#tag/Cookie-Authentication)" section
x-tagGroups:
- name: Client Authentication
  tags:
  - API KEY Authentication
  - Cookie Authentication
  - OAuth Authorization
- name: Common Parameters
  tags:
  - Optional Fields
  - Expandable Fields
- name: Requests
  tags:
  - User
  - Accounts
  - AI content
  - Collaborators
  - API Keys
  - Projects
  - SDK Keys
  - Experiences
  - Experience Variations
  - Experience Sections
  - Section Versions
  - Version Changes
  - Experiences Reports
  - Experiences Heatmaps
  - Goals
  - Hypotheses
  - Knowledge Bases
  - Observations
  - Locations
  - Audiences
  - Domains
  - Cdn Images
  - Files
  - Tags
  - Features
  - Visitor Insights
  - Visitors Data
  - Visitor Data Placeholders
  - OAuth