Uniform Integrations API

The Integrations API from Uniform — 5 operation(s) for integrations.

Operations 19

DELETE /api/v1/integration-credentials
POST /api/v1/integration-credentials
OPTIONS /api/v1/integration-credentials
GET /api/v1/integration-definitions
DELETE /api/v1/integration-definitions
PUT /api/v1/integration-definitions
OPTIONS /api/v1/integration-definitions
GET /api/v1/integration-edgehancers
DELETE /api/v1/integration-edgehancers
PUT /api/v1/integration-edgehancers
OPTIONS /api/v1/integration-edgehancers
GET /api/v1/integration-installations
DELETE /api/v1/integration-installations
PUT /api/v1/integration-installations
OPTIONS /api/v1/integration-installations
GET /api/v1/integration-property-editors
DELETE /api/v1/integration-property-editors
PUT /api/v1/integration-property-editors
OPTIONS /api/v1/integration-property-editors

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • 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/uniform-integrations-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 email required.

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

OpenAPI Specification

uniform-integrations-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Uniform Platform Aggregates Integrations API
  version: '2.0'
servers:
- url: https://uniform.app
  description: Base URL declared by the provider in apis.yml (roadmap#122).
tags:
- name: Integrations
paths:
  /api/v1/integration-credentials:
    delete:
      description: Revokes the credential for an integration definition. Future grants and refreshes will fail until a new credential is minted. In-flight delegation tokens remain valid until natural expiry.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                teamId:
                  type: string
                  format: uuid
                  description: The team ID that owns the integration
                integrationDefinitionId:
                  type: string
                  format: uuid
                  description: The integration definition ID to mint or revoke credentials for
                kind:
                  type: string
                  enum:
                  - app_secret
                  description: Kind of credential to rotate or revoke. Currently only `app_secret` is supported.
              required:
              - teamId
              - integrationDefinitionId
              - kind
              additionalProperties: false
      responses:
        '204':
          description: Credential revoked
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          description: Integration definition not found in this team, or no credential of the given kind is configured
        '429':
          $ref: '#/components/responses/RateLimitError'
        '500':
          $ref: '#/components/responses/InternalServerError'
      tags:
      - Integrations
      security:
      - ApiKeyAuth: []
      - BearerAuth: []
    post:
      description: 'Mints or rotates the credential for an integration definition. Atomic: a successful response invalidates any previously-issued secret of the same kind. The plaintext secret is returned in the response body and cannot be retrieved later.'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                teamId:
                  type: string
                  format: uuid
                  description: The team ID that owns the integration
                integrationDefinitionId:
                  type: string
                  format: uuid
                  description: The integration definition ID to mint or revoke credentials for
                kind:
                  type: string
                  enum:
                  - app_secret
                  description: Kind of credential to rotate or revoke. Currently only `app_secret` is supported.
              required:
              - teamId
              - integrationDefinitionId
              - kind
              additionalProperties: false
      responses:
        '200':
          description: Credential minted or rotated.
          content:
            application/json:
              schema:
                type: object
                properties:
                  kind:
                    type: string
                    enum:
                    - app_secret
                    description: Kind of credential to rotate or revoke. Currently only `app_secret` is supported.
                  integrationDefinitionId:
                    type: string
                    format: uuid
                  appSecret:
                    type: string
                    description: Plaintext app secret. Only returned on this response; cannot be retrieved later.
                  createdAt:
                    type: string
                    description: ISO timestamp when the secret became effective.
                required:
                - kind
                - integrationDefinitionId
                - appSecret
                - createdAt
                additionalProperties: false
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          description: Integration definition not found in this team
        '429':
          $ref: '#/components/responses/RateLimitError'
        '500':
          $ref: '#/components/responses/InternalServerError'
      tags:
      - Integrations
      security:
      - ApiKeyAuth: []
      - BearerAuth: []
    options:
      tags:
      - Integrations
      responses:
        '204':
          description: ok
      description: Handles preflight requests. This endpoint allows CORS.
  /api/v1/integration-definitions:
    get:
      description: Gets a list of Mesh apps that are available for a Uniform team
      parameters:
      - schema:
          type: string
          description: The team ID
        required: true
        description: The team ID
        name: teamId
        in: query
      - schema:
          type:
          - boolean
          - 'null'
          default: false
          description: Whether to include Mesh apps that are shared publicly to all teams, or only custom apps registered on this team.
        required: false
        description: Whether to include Mesh apps that are shared publicly to all teams, or only custom apps registered on this team.
        name: includePublic
        in: query
      - schema:
          type:
          - boolean
          - 'null'
          description: Whether to use team-specific integration types or team-agnostic types (for serialization across projects)
        required: false
        description: Whether to use team-specific integration types or team-agnostic types (for serialization across projects)
        name: teamSpecificType
        in: query
      responses:
        '200':
          description: 200 response
          content:
            application/json:
              schema:
                type: object
                properties:
                  results:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          minLength: 2
                          pattern: ^[a-z0-9-_]+$
                        displayName:
                          type: string
                          minLength: 1
                        logoIconUrl:
                          type: string
                        badgeIconUrl:
                          type: string
                        category:
                          type: string
                          enum:
                          - analytics
                          - cdn
                          - classic
                          - commerce
                          - content
                          - comingSoon
                          - data
                          - deprecated
                          - email
                          - framework
                          - search
                          - starters
                          - translation
                          - uniform
                          - ai
                          - unknown
                        public:
                          type: boolean
                        scopes:
                          type: array
                          items:
                            type: string
                        identityDelegation:
                          type: boolean
                        integrationId:
                          type: string
                          format: uuid
                        hasAppSecret:
                          type: boolean
                        baseLocationUrl:
                          type: string
                        locations:
                          type: object
                          properties:
                            install:
                              type: object
                              properties:
                                description:
                                  type: array
                                  items:
                                    type: string
                                informationUrl:
                                  type: string
                                canvasPackageUrl:
                                  type: string
                            settings:
                              type: object
                              properties:
                                url:
                                  type: string
                                locations:
                                  type: object
                                  additionalProperties:
                                    type: object
                                    properties:
                                      url:
                                        type: string
                                      layout:
                                        type: object
                                        properties:
                                          height:
                                            type: string
                                            enum:
                                            - full-height
                                          width:
                                            type: string
                                            enum:
                                            - wide
                                        additionalProperties: false
                                    required:
                                    - url
                                    additionalProperties: false
                              required:
                              - url
                            canvas:
                              type: object
                              properties:
                                parameterTypes:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      type:
                                        type: string
                                      displayName:
                                        type: string
                                      configureUrl:
                                        type: string
                                      editorUrl:
                                        type: string
                                      configurationLocations:
                                        type: object
                                        additionalProperties:
                                          type: object
                                          properties:
                                            url:
                                              type: string
                                            layout:
                                              type: object
                                              properties:
                                                height:
                                                  type: string
                                                  enum:
                                                  - full-height
                                                width:
                                                  type: string
                                                  enum:
                                                  - wide
                                              additionalProperties: false
                                          required:
                                          - url
                                          additionalProperties: false
                                      editorLocations:
                                        type: object
                                        additionalProperties:
                                          type: object
                                          properties:
                                            url:
                                              type: string
                                            layout:
                                              type: object
                                              properties:
                                                height:
                                                  type: string
                                                  enum:
                                                  - full-height
                                                width:
                                                  type: string
                                                  enum:
                                                  - wide
                                              additionalProperties: false
                                          required:
                                          - url
                                          additionalProperties: false
                                      renderableInPropertyPanel:
                                        type: boolean
                                      localizable:
                                        type: string
                                        enum:
                                        - default-yes
                                        - default-no
                                        - 'yes'
                                        - 'no'
                                      allowedPlacement:
                                        type: array
                                        items:
                                          type: string
                                          enum:
                                          - parameter
                                          - field
                                    required:
                                    - type
                                    - displayName
                                    - editorUrl
                                editorTools:
                                  anyOf:
                                  - type: object
                                    properties:
                                      composition:
                                        type: object
                                        properties:
                                          url:
                                            type: string
                                        required:
                                        - url
                                      componentPattern:
                                        type: object
                                        properties:
                                          url:
                                            type: string
                                        required:
                                        - url
                                      compositionDefaults:
                                        type: object
                                        properties:
                                          url:
                                            type: string
                                        required:
                                        - url
                                      entry:
                                        type: object
                                        properties:
                                          url:
                                            type: string
                                        required:
                                        - url
                                      entryPattern:
                                        type: object
                                        properties:
                                          url:
                                            type: string
                                        required:
                                        - url
                                  - type: array
                                    items:
                                      type: object
                                      properties:
                                        id:
                                          type: string
                                          minLength: 1
                                        name:
                                          type: string
                                          minLength: 1
                                        url:
                                          type: string
                                          minLength: 1
                                        iconUrl:
                                          type: string
                                        access:
                                          type: object
                                          properties:
                                            teamAdminRequired:
                                              type: boolean
                                              enum:
                                              - true
                                          additionalProperties: false
                                        editorTypes:
                                          type: array
                                          items:
                                            type: string
                                            enum:
                                            - composition
                                            - componentPattern
                                            - compositionDefaults
                                            - entry
                                            - entryPattern
                                      required:
                                      - id
                                      - name
                                      - url
                                personalization:
                                  type: object
                                  properties:
                                    selectionAlgorithms:
                                      type: object
                                      additionalProperties:
                                        type: object
                                        properties:
                                          displayName:
                                            type: string
                                          description:
                                            type: string
                                          criteriaEditorUrl:
                                            type: string
                                        required:
                                        - displayName
                            dataConnectors:
                              type: array
                              items:
                                type: object
                                properties:
                                  type:
                                    type: string
                                  displayName:
                                    type: string
                                  dataSourceEditorUrl:
                                    type: string
                                  supportsUnpublishedData:
                                    type: boolean
                                  dataSourceEditorLocations:
                                    type: object
                                    additionalProperties:
                                      type: object
                                      properties:
                                        url:
                                          type: string
                                        layout:
                                          type: object
                                          properties:
                                            height:
                                              type: string
                                              enum:
                                              - full-height
                                            width:
                                              type: string
                                              enum:
                                              - wide
                                          additionalProperties: false
                                      required:
                                      - url
                                      additionalProperties: false
                                  dataArchetypes:
                                    type: object
                                    additionalProperties:
                                      type: object
                                      properties:
                                        displayName:
                                          type: string
                                        typeEditorUrl:
                                          type: string
                                        typeEditorLocations:
                                          type: object
                                          additionalProperties:
                                            type: object
                                            properties:
                                              url:
                                                type: string
                                              layout:
                                                type: object
                                                properties:
                                                  height:
                                                    type: string
                                                    enum:
                                                    - full-height
                                                  width:
                                                    type: string
                                                    enum:
                                                    - wide
                                                additionalProperties: false
                                            required:
                                            - url
                                            additionalProperties: false
                                        dataEditorUrl:
                                          type: string
                                        dataEditorUrlLocations:
                                          type: object
                                          additionalProperties:
                                            type: object
                                            properties:
                                              url:
                                                type: string
                                              layout:
                                                type: object
                                                properties:
                                                  height:
                                                    type: string
                                                    enum:
                                                    - full-height
                                                  width:
                                                    type: string
                                                    enum:
                                                    - wide
                                                additionalProperties: false
                                            required:
                                            - url
                                            additionalProperties: false
                                        embeddedEditor:
                                          type: string
                                        dataResourceSelectorUrl:
                                          type: string
                                        dataResourceSelectorLocations:
                                          type: object
                                          additionalProperties:
                                            type: object
                                            properties:
                                              url:
                                                type: string
                                              layout:
                                                type: object
                                                properties:
                                                  height:
                                                    type: string
                                                    enum:
                                                    - full-height
                                                  width:
                                                    type: string
                                                    enum:
                                                    - wide
                                                additionalProperties: false
                                            required:
                                            - url
                                            additionalProperties: false
                                      required:
                                      - displayName
                                  badgeIconUrl:
                                    type: string
                                required:
                                - type
                                - displayName
                            assetLibrary:
                              type: object
                              properties:
                                assetLibraryUrl:
                                  type: string
                                assetParameterUrl:
                                  type: string
                                assetLibraryLocations:
                                  type: object
                                  additionalProperties:
                                    type: object
                                    properties:
                                      url:
                                        type: string
                                      layout:
                                        type: object
                                        properties:
                                          height:
                                            type: string
                                            enum:
                                            - full-height
                                          width:
                                            type: string
                                            enum:
                                            - wide
                                        additionalProperties: false
                                    required:
                                    - url
                                    additionalProperties: false
                                unstable_dynamicAssets:
                                  type: object
                                  properties:
                                    dataConnectorId:
                                      type: string
                                    assetsListArchetypeId:
                                      type: string
                                    singleAssetArchetypeId:
                                      type: string
                                  required:
                                  - dataConnectorId
                                  - assetsListArchetypeId
                                  - singleAssetArchetypeId
                              required:
                              - assetLibraryUrl
                              - assetParameterUrl
                            unstable_assetLibrary:
                              type: object
                              properties:
                                url:
                                  type: string
                                dynamicAssets:
                                  type: object
                                  properties:
                                    dataConnectorId:
                                      type: string
                                    assetsListArchetypeId:
                                      type: string
                                    singleAssetArchetypeId:
                                      type: string
                                  required:
                                  - dataConnectorId
                                  - assetsListArchetypeId
                                  - singleAssetArchetypeId
                              required:
                              - url
                            ai:
                              type: object
                              properties:
                                generateUrl:
                                  type: string
                                metadataUrl:
                                  type: string
                                prompts:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      id:
                                        type: string
                                      name:
                                        type: string
                                      text:
                                        type: string
                                      data:
                                        type:
                                        - object
                                        - 'null'
                                        properties:
                                          arguments:
                                            type:
                                            - object
                                            - 'null'
                                            additionalProperties:
                                              type: object
                                              properties:
                                                type:
                                                  type: string
                                                displayName:
                                                  type:
                                                  - string
                                                  - 'null'
                                                helpText:
                                                  type:
                                                  - string
                                                  - 'null'
                                                default:
                                                  type:
                                                  - string
                                                  - 'null'
                                              required:
                                              - type
                                          metadata: {}
                                      parameterTypes:
                                        type: array
                                        items:
                                          type: string
                                    required:
                                    - id
                                    - name
                                    - text
                                    - parameterTypes
                              required:
                              - generateUrl
                            unstable_ai:
                              type: object
                              properties:
                                generateUrl:
                                  type: string
                                metadataUrl:
                                  type: string
                              required:

# --- truncated at 32 KB (124 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/uniform/refs/heads/main/openapi/uniform-integrations-api-openapi.yml