Prismatic Graph QL API

openapi: 3.2.0
info:
  title: Prismatic Authentication Graph QL API
  description: Prismatic provides a GraphQL-based API for building, deploying, and supporting integrations programmatically. The API allows you to manage customers, integrations, instances, components, and other resources. GraphQL operations include queries (pulling data) and mutations (creating, modifying, or deleting data). The API endpoint accepts GraphQL queries via HTTP POST requests. Authentication is handled via JWT bearer tokens obtained through the Prismatic web app or CLI tool.
  version: 1.0.0
  contact:
    name: Prismatic
    url: https://prismatic.io
  license:
    name: Proprietary
    url: https://prismatic.io/legal/terms/
  x-topics:
  - Integrations
  - Embedded SaaS Integration
  - Workflows
  - Connectors
  - GraphQL
servers:
- url: https://app.prismatic.io
  description: Prismatic Production API
tags:
- name: Graph QL
  description: GraphQL API endpoint for querying and mutating Prismatic resources including customers, integrations, instances, and components
paths:
  /api:
    post:
      operationId: executeGraphQLQuery
      summary: Prismatic Execute GraphQL Query or Mutation
      description: Execute a GraphQL query or mutation against the Prismatic API. This endpoint accepts standard GraphQL request bodies containing a query string, optional variables, and an optional operation name. Use queries to retrieve data about customers, integrations, instances, components, and other resources. Use mutations to create, update, or delete resources. Rate limited to 20 requests per second.
      tags:
      - Graph QL
      security:
      - bearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GraphQLRequest'
            examples:
              listCustomers:
                summary: List all customers
                value:
                  query: "query listCustomers {\n  customers {\n    nodes {\n      id\n      name\n      externalId\n    }\n  }\n}"
              listIntegrations:
                summary: List all integrations
                value:
                  query: "query listIntegrations {\n  integrations {\n    nodes {\n      id\n      name\n      description\n    }\n  }\n}"
              listComponents:
                summary: List all components
                value:
                  query: "query listComponents {\n  components {\n    nodes {\n      id\n      label\n      description\n      key\n      authorizationRequired\n    }\n  }\n}"
              listInstances:
                summary: List all instances
                value:
                  query: "query listInstances {\n  instances {\n    nodes {\n      id\n      name\n      customer {\n        id\n        name\n      }\n      integration {\n        id\n        name\n      }\n    }\n  }\n}"
              createCustomer:
                summary: Create a new customer
                value:
                  query: "mutation createCustomer($name: String!, $externalId: String) {\n  createCustomer(input: { name: $name, externalId: $externalId }) {\n    customer {\n      id\n      name\n      externalId\n    }\n  }\n}"
                  variables:
                    name: Acme Corp
                    externalId: acme-123
      responses:
        '200':
          description: GraphQL response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GraphQLResponse'
        '401':
          description: Unauthorized - invalid or expired JWT token
        '429':
          description: Rate limit exceeded - maximum 20 requests per second
components:
  schemas:
    GraphQLError:
      type: object
      properties:
        message:
          type: string
          description: Human-readable error message
        locations:
          type: array
          description: Locations in the query where the error occurred
          items:
            type: object
            properties:
              line:
                type: integer
              column:
                type: integer
        path:
          type: array
          description: Path to the field that caused the error
          items:
            type: string
        extensions:
          type: object
          description: Additional error information
          additionalProperties: true
    GraphQLRequest:
      type: object
      required:
      - query
      properties:
        query:
          type: string
          description: The GraphQL query or mutation string. Queries retrieve data while mutations create, update, or delete resources.
        variables:
          type: object
          description: Optional variables to pass to the GraphQL query or mutation. Variables are referenced in the query string using the $ prefix.
          additionalProperties: true
        operationName:
          type: string
          description: Optional name of the operation to execute if the query string contains multiple named operations.
    GraphQLResponse:
      type: object
      properties:
        data:
          type: object
          description: The result data from the GraphQL query or mutation. Structure matches the shape of the query.
          additionalProperties: true
        errors:
          type: array
          description: Array of error objects if the query or mutation encountered errors.
          items:
            $ref: '#/components/schemas/GraphQLError'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT token obtained via the Prismatic web app, CLI tool (me:token subcommand), or the /auth/refresh endpoint. Pass as Authorization Bearer header.
    cookieAuth:
      type: apiKey
      in: cookie
      name: session
      description: Session cookie from Prismatic web application login