Inflection.io Contact Activity API

openapi: 3.2.0
info:
  title: Inflection Developer Contact Activity API
  version: 1.0.0
  description: 'The Inflection Developer API (`/v2`). Authenticate with a Personal Access

    Token (`Authorization: Bearer inf_pat_...`).


    **`/v2` is `/v1` plus more.** Every `/v1` endpoint is served here unchanged,

    so a client can pin to one version and reach the whole API. On top of those

    sit reads `/v1` never had: journeys, journey and email stats with a journey

    rollup, and the email and list collections. `/v1` remains published.


    **Response envelope.** Every response is wrapped:

    `{ "data": …, "pagination": …, "errors": [...], "meta": { "status": "SUCCESS|FAILURE", "timestamp": "…" } }`.

    `data` carries the payload, `pagination` appears only on paged lists, and on

    failures `errors` is populated with `meta.status: "FAILURE"`.


    **Query parameters are camelCase**: `pageNumber`, `pageSize`, `startTime`,

    `folderId`. The journeys, emails, lists and stats reads additionally accept

    the snake_case spelling of every scalar parameter (`page_number`,

    `folder_id`, …); the contact, activity and list-member endpoints do not.

    Repeatable parameters also accept a `[]` suffix (`status[]`, `tag[]`).


    **Asynchronous contact writes.** `POST/PATCH /v2/contacts*` are processed

    asynchronously: they return **200** with a `PENDING` transaction

    acknowledgement (not the created/updated contact). Poll

    `GET /v2/contacts/transactions/{transactionId}` for the per-contact result.


    **Status-code quirks** (documented per-operation): a missing **contact** is

    reported as **400** (not 404), whereas a missing **list**, **email** or

    **journey** is **404**. For journeys and emails that also covers a

    soft-deleted record and a malformed id. Nothing returns 201 or 204.


    **Empty results are not errors.** On the paged reads, a `tag`, `folderId` or

    `search` that matches nothing returns an empty page, not a 404.


    **Errors.** Failures use the envelope above

    (`errors[].{errorCode,message,detail}`). Authentication and authorization

    failures (401/403) are returned with an empty body. The journey stats rollup

    adds `RESULT_SET_TOO_LARGE` (a **400**) when a filter matches more journeys

    than one request may cover; narrow it rather than paging further.


    **Rate limiting.** Requests are metered per tenant. Exceeding the budget

    yields **429** (empty body) on any endpoint; the `Retry-After` header gives

    the seconds to wait and `X-RateLimit-Limit` the sustained per-second budget.'
servers:
- url: https://api.inflection.io
  description: Production
security:
- PatAuth: []
tags:
- name: Contact Activity
  description: Product, marketing, and combined activity for a contact, plus Salesforce data.
paths:
  /v2/contacts/{id}/product-activity:
    get:
      tags:
      - Contact Activity
      operationId: getContactProductActivity
      summary: Get a contact's product activity
      description: Paged list of product (in-app) events for the contact. Returns an empty list for an unknown contact.
      parameters:
      - $ref: '#/components/parameters/ContactId'
      - $ref: '#/components/parameters/PageNumber'
      - $ref: '#/components/parameters/PageSize'
      - $ref: '#/components/parameters/StartTime'
      - $ref: '#/components/parameters/EndTime'
      responses:
        '200':
          description: Paged product-activity records.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProductActivityResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
  /v2/contacts/{id}/marketing-activity:
    get:
      tags:
      - Contact Activity
      operationId: getContactMarketingActivity
      summary: Get a contact's marketing activity
      description: 'Paged list of marketing events (campaigns, forms, website visits, etc.).

        Item shape varies by `activityType`; `context` and `additionalData` are

        free-form. Returns an empty list for an unknown contact.'
      parameters:
      - $ref: '#/components/parameters/ContactId'
      - $ref: '#/components/parameters/PageNumber'
      - $ref: '#/components/parameters/PageSize'
      - $ref: '#/components/parameters/StartTime'
      - $ref: '#/components/parameters/EndTime'
      responses:
        '200':
          description: Paged marketing-activity records.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MarketingActivityResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
  /v2/contacts/{id}/activity-log:
    get:
      tags:
      - Contact Activity
      operationId: getContactActivityLog
      summary: Get a contact's activity log
      description: 'Paged, combined activity log. `eventTypes` filters to internal types

        (`Contact Event`, `User Event`); other values are ignored.

        `activityProperties` is free-form. Returns an empty list for an unknown

        contact.'
      parameters:
      - $ref: '#/components/parameters/ContactId'
      - $ref: '#/components/parameters/PageNumber'
      - $ref: '#/components/parameters/PageSize'
      - $ref: '#/components/parameters/StartTime'
      - $ref: '#/components/parameters/EndTime'
      - name: eventTypes
        in: query
        required: false
        description: Repeatable. Only `Contact Event` and `User Event` are honored.
        schema:
          type: array
          items:
            type: string
            enum:
            - Contact Event
            - User Event
      responses:
        '200':
          description: Paged activity-log records.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActivityLogResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
  /v2/contacts/{id}/salesforce:
    get:
      tags:
      - Contact Activity
      operationId: getContactSalesforce
      summary: Get a contact's Salesforce record
      description: 'Returns the contact''s mapped Salesforce record as a free-form object, or

        `null` data if the contact exists but has no Salesforce record. The field

        set may change.'
      parameters:
      - $ref: '#/components/parameters/ContactId'
      responses:
        '200':
          description: The Salesforce record (free-form), or null data if none.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SalesforceResponse'
        '404':
          description: Contact not found, or the contact has no email.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
components:
  schemas:
    ActivityLogResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ActivityLogEntry'
        pagination:
          $ref: '#/components/schemas/Pagination'
        meta:
          $ref: '#/components/schemas/Meta'
    SalesforceResponse:
      type: object
      properties:
        data:
          type: object
          additionalProperties: true
          description: The Salesforce record (free-form), or absent when the contact has no Salesforce record.
        meta:
          $ref: '#/components/schemas/Meta'
    ErrorItem:
      type: object
      properties:
        errorCode:
          type: string
          examples:
          - NOT_FOUND
        message:
          type: string
        detail:
          type: string
      required:
      - errorCode
      - message
    MarketingActivity:
      type: object
      description: Shape varies by `activityType`; `context` and `additionalData` are free-form.
      properties:
        timestamp:
          type: string
        event:
          type: string
          description: e.g. Opened, Clicked, Form Submitted, Sent.
        context:
          description: Free-form; may be null, a string (e.g. a URL), or an object.
        activityType:
          type: string
          enum:
          - campaign
          - form
          - template
          - website_visit
          - ingestion_webhook
        id:
          type: string
        name:
          type: string
        isDeleted:
          type: boolean
        additionalData:
          type: object
          additionalProperties: true
          description: Type-dependent extra data (submission id, campaign/template info, website-visit fields, …).
    Meta:
      type: object
      description: Envelope metadata present on every response.
      properties:
        status:
          type: string
          enum:
          - SUCCESS
          - FAILURE
        timestamp:
          type: string
          format: date-time
      required:
      - status
    ProductActivity:
      type: object
      properties:
        userId:
          type: string
        orgId:
          type: string
        eventName:
          type: string
        eventDate:
          type: string
        eventProperties:
          type: object
          additionalProperties: true
          description: Free-form, customer-defined event properties.
    MarketingActivityResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/MarketingActivity'
        pagination:
          $ref: '#/components/schemas/Pagination'
        meta:
          $ref: '#/components/schemas/Meta'
    ActivityLogEntry:
      type: object
      properties:
        activityName:
          type: string
        activityType:
          type: string
          enum:
          - Marketing Activity
          - Product Activity
          - Contact Event
          - User Event
        productUserId:
          type: string
        orgId:
          type: string
        timestamp:
          type: string
        createdTime:
          type: string
        logTime:
          type: string
        activityProperties:
          type: object
          additionalProperties: true
          description: Free-form; shape depends on `activityType`.
    ProductActivityResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ProductActivity'
        pagination:
          $ref: '#/components/schemas/Pagination'
        meta:
          $ref: '#/components/schemas/Meta'
    Pagination:
      type: object
      description: Present only on paged list responses.
      properties:
        pageNumber:
          type: integer
        pageSize:
          type: integer
        totalElements:
          type: integer
        totalPages:
          type: integer
    ErrorEnvelope:
      type: object
      description: Standard failure envelope.
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/ErrorItem'
        meta:
          $ref: '#/components/schemas/Meta'
  responses:
    Unauthorized:
      description: Missing or invalid Personal Access Token. Empty body.
    BadRequest:
      description: Malformed request or validation error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    TooManyRequests:
      description: 'Per-tenant rate limit exceeded. Empty body. Retry after the number of

        seconds given in the `Retry-After` header.

        '
      headers:
        Retry-After:
          description: Seconds to wait before retrying.
          schema:
            type: integer
        X-RateLimit-Limit:
          description: Sustained request budget, in requests per second, per tenant.
          schema:
            type: integer
    Forbidden:
      description: The PAT lacks the required scope (READ for reads, WRITE for writes). Empty body.
  parameters:
    PageSize:
      name: pageSize
      in: query
      required: false
      description: Items per page.
      schema:
        type: integer
        minimum: 1
        maximum: 200
        default: 20
    ContactId:
      name: id
      in: path
      required: true
      description: Contact id.
      schema:
        type: string
    EndTime:
      name: endTime
      in: query
      required: false
      description: ISO-8601 upper bound (inclusive) for the activity window.
      schema:
        type: string
        format: date-time
    PageNumber:
      name: pageNumber
      in: query
      required: false
      description: 1-based page number.
      schema:
        type: integer
        minimum: 1
        maximum: 2147483647
        default: 1
    StartTime:
      name: startTime
      in: query
      required: false
      description: ISO-8601 lower bound (inclusive) for the activity window.
      schema:
        type: string
        format: date-time
  securitySchemes:
    PatAuth:
      type: http
      scheme: bearer
      bearerFormat: inf_pat
      description: 'Personal Access Token or OAuth 2.1 access token, sent as a bearer

        credential (`Authorization: Bearer inf_pat_...`). Read operations

        require a token with the `READ` scope; write operations

        (POST/PATCH/DELETE) require `WRITE`.

        '
x-provenance:
  method: harvested
  publisher: Inflection.io
  source: https://docs.inflection.io/api-reference/openapi.yaml
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)