Consequential API

openapi: 3.1.0
info:
  title: Consequential API
  version: '2026-11-04'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-11-04: 8 operation(s) read from 5 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; Consequential has published no machine-readable contract that
    the pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 3
    documentation: 5
    pages-with-code: 3
    pages-read: 5
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-11-04'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://docs.consequential.io/integrations-platform-setup/partner-integrations/partner-integration-setup
  - https://docs.consequential.io/faq/advertising-best-practices/automating-audience-sync-from-a-cdp-to-meta
  - https://docs.consequential.io/guides/send-your-first-request
  - https://docs.consequential.io/integrations-platform-setup/cdp-integrations/http/data
  - https://docs.consequential.io/integrations-platform-setup/cdp-integrations/http/event
servers:
- url: https://app.consequential.io
paths:
  /api/v1/tenants:
    get:
      operationId: get_api_v1_tenants
      tags:
      - Api
      summary: GET /api/v1/tenants
      x-source: https://docs.consequential.io/guides/send-your-first-request
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl JavaScript Terminal window curl https://app.consequential.io/api/v1/tenants/ $TENANT_ID /reports \ -H " Authorization:
          Bearer $TOKEN " \ -H " X-Tenant-ID: $TENANT_ID " const reports = await fetch ( ` https://app.consequential.io/api/v1/tenants/ ${tenantId}
          /reports ` , { headers: { Authorization: ` Bearer ${ process . env . TOKEN } ` , '' X-Tenant-ID '' : tenantId , }, }, ) . then ( ( r
          ) => r '
  /api/v1/tenants/:
    get:
      operationId: get_api_v1_tenants
      tags:
      - Api
      summary: List all tenants (platform member role required)
      x-source: https://docs.consequential.io/guides/send-your-first-request
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /data:
    post:
      operationId: post_data
      tags:
      - Data
      summary: POST /data
      x-source: https://docs.consequential.io/integrations-platform-setup/cdp-integrations/http/data
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl --request POST \ --url https://abc.domain.com/data \ --header '' Content-Type: application/json '' \ --header '' EdgeTagUserId:
          138fffcd-ee39-4fd1-b5b5-760f07454407-1662025231518 '' \ --data '' { "data": { "email": "jsmith@test.com", "firstName": "John", "lastName":
          "Smith", "color": "Blue", "step": "5" } } '' Previous User info Next Event'
  /partner/connect:
    post:
      operationId: post_partner_connect
      tags:
      - Partner
      summary: Connect a merchant
      x-source: https://docs.consequential.io/integrations-platform-setup/partner-integrations/partner-integration-setup
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostPartnerConnectRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostPartnerConnectResponse'
      x-evidence:
        kind: documentation
  /partner/data/acquisition/{view}:
    get:
      operationId: get_partner_data_acquisition_view
      tags:
      - Partner
      summary: Read acquisition data
      x-source: https://docs.consequential.io/integrations-platform-setup/partner-integrations/partner-integration-setup
      parameters:
      - name: view
        in: path
        required: true
        schema:
          type: string
      - name: shop_domain
        in: query
        required: true
        schema:
          type: string
        description: Shopify shop domain
      - name: start_date
        in: query
        required: true
        schema:
          type: string
        description: Start date in YYYY‑MM‑DD format
      - name: end_date
        in: query
        required: true
        schema:
          type: string
        description: End date in YYYY‑MM‑DD format
      - name: currency
        in: query
        required: false
        schema:
          type: string
        description: Currency code
      - name: timezone
        in: query
        required: false
        schema:
          type: string
        description: IANA timezone
      - name: model
        in: query
        required: false
        schema:
          type: string
        description: 'Attribution model: last_click, first_click, or platform'
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPartnerDataAcquisitionViewResponse'
      x-evidence:
        kind: documentation
  /partner/login:
    get:
      operationId: get_partner_login
      tags:
      - Partner
      summary: Browser login (GET /partner/login)
      x-source: https://docs.consequential.io/integrations-platform-setup/partner-integrations/partner-integration-setup
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /tag:
    get:
      operationId: get_tag
      tags:
      - Tag
      summary: GET /tag
      x-source: https://docs.consequential.io/integrations-platform-setup/cdp-integrations/http/event
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl --request GET \ --url https://abc.domain.com/tag \ --header '' Content-Type: application/json '' \ --header '' EdgeTagUserId:
          138fffcd-ee39-4fd1-b5b5-760f07454407-1662025231518 '' \ --data '' { "data": { "value": 10.50, "currency": "USD", "contents": [ { "id":
          "123123123", "quantity": 1, "item_price": 10.50, "title": "Summer Fun", "category": "bracelets", "image": "https://domain.com/product/fun-m'
  /v19.0/{audienceId}/users:
    post:
      operationId: post_v19_0_audienceId_users
      tags:
      - V19
      summary: Upload users via API
      description: Endpoint to upload hashed user identifiers to a Meta Custom Audience.
      x-source: https://docs.consequential.io/faq/advertising-best-practices/automating-audience-sync-from-a-cdp-to-meta
      parameters:
      - name: audienceId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostV190AudienceidUsersRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
components:
  schemas:
    PostPartnerConnectRequest:
      type: object
      properties:
        shop_domain:
          type: string
          description: Merchant’s Shopify shop domain
        tenant_name:
          type: string
          description: Display name for the tenant
        email:
          type: string
          description: Email address of the merchant
      required:
      - shop_domain
      - tenant_name
      - email
    PostPartnerConnectResponse:
      type: object
      properties:
        access_token:
          type: string
          description: Short‑lived JWT (10 minutes)
        token_type:
          type: string
          description: Bearer
        expires_in:
          type: integer
          description: Expiration in seconds (600)
        tenant_id:
          type: string
          description: Tenant’s public identifier
        onboarding_status:
          type: string
          description: CREATED, ONBOARDING, or ACTIVE
        redirect_url:
          type: string
          description: URL to open in the merchant’s browser
        is_new_tenant:
          type: boolean
          description: Whether this call just created the tenant
    GetPartnerDataAcquisitionViewResponse:
      type: object
      properties:
        success:
          type: boolean
          description: Indicates request success
        metadata:
          type: object
          description: Contains shape_format, bucket, resource, timestamp, tenant_id, etc.
        shapes:
          type: array
          description: Array of shape objects each with id, type, purpose, native, metadata, aggregation, data
    PostV190AudienceidUsersRequest:
      type: object
      properties:
        schema:
          type: array
          description: Array of identifier types, e.g., ["EMAIL"]
        data:
          type: array
          description: Array of arrays, each inner array containing a hashed identifier value
      required:
      - schema
      - data
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
security:
- bearer: []
tags:
- name: Api
- name: Data
- name: Partner
- name: Tag
- name: V19