Inflection.io Organizations API

openapi: 3.2.0
info:
  title: Inflection Developer Organizations 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: Organizations
  description: Read organizations (company accounts) and a contact's memberships.
paths:
  /v2/contacts/{id}/orgs:
    get:
      tags:
      - Organizations
      operationId: listContactOrganizations
      summary: List a contact's organizations
      description: 'The distinct organizations the contact belongs to. A contact holding

        several product users in one organization yields that organization once.'
      parameters:
      - $ref: '#/components/parameters/ContactId'
      - $ref: '#/components/parameters/PageNumber'
      - $ref: '#/components/parameters/PageSize'
      responses:
        '200':
          description: Paged organizations.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrganizationListResponse'
        '400':
          description: 'Malformed request, or `RESULT_SET_TOO_LARGE` when the contact belongs

            to more organizations than one request may cover.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
  /v2/orgs/{id}/users:
    post:
      tags:
      - Organizations
      operationId: addOrganizationUsers
      summary: Add product users to an organization
      description: 'Asynchronous. The response is a transaction to poll, with one item per

        user. Membership is many-to-many, so adding a user does not remove any of

        its existing organizations.'
      parameters:
      - $ref: '#/components/parameters/OrganizationId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrganizationUsersInput'
      responses:
        '200':
          description: A pending transaction.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProductUserTransactionResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
  /v2/orgs:
    post:
      tags:
      - Organizations
      operationId: createOrganization
      summary: Create an organization
      description: 'Synchronous, unlike contact and product-user writes: organizations have no

        asynchronous pipeline, so the created organization is returned directly

        rather than a transaction to poll.


        A property whose name matches a column on your organization table is

        written to that column as well as to the stored property bag, so it reads

        back the same way an ingested organization does. A property with no

        matching column is still stored, but only in the bag. Names the platform

        owns (`id`, `_source`, `properties`, `properties_timestamp` and the

        `_*_time` audit columns) are rejected.'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrganizationInput'
      responses:
        '200':
          description: The created organization.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrganizationResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '409':
          description: An organization with this id already exists; use PATCH instead.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '429':
          $ref: '#/components/responses/TooManyRequests'
  /v2/orgs/{id}:
    get:
      tags:
      - Organizations
      operationId: getOrganization
      summary: Get an organization
      parameters:
      - $ref: '#/components/parameters/OrganizationId'
      responses:
        '200':
          description: The organization. `data.properties` carries the full stored row.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrganizationResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
    patch:
      tags:
      - Organizations
      operationId: updateOrganization
      summary: Update an organization
      description: 'Synchronous, like create. Supply `name`, `properties`, or both; a body with

        neither is rejected. Properties are merged into the stored bag rather than

        replacing it, so omitting a key leaves it untouched. There is no way to

        remove a key through this endpoint.'
      parameters:
      - $ref: '#/components/parameters/OrganizationId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrganizationPatch'
      responses:
        '200':
          description: The updated organization.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrganizationResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
components:
  schemas:
    OrganizationResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/Organization'
        meta:
          $ref: '#/components/schemas/Meta'
    OrganizationInput:
      type: object
      properties:
        orgId:
          type: string
          description: 'Your own organization id. Omit it and one is generated for you.

            '
        name:
          type: string
          description: Organization display name.
        properties:
          type: object
          additionalProperties: true
          description: 'Organization properties, keyed in snake_case. A name matching one of

            your organization columns is written to that column too.

            '
      required:
      - name
    ErrorItem:
      type: object
      properties:
        errorCode:
          type: string
          examples:
          - NOT_FOUND
        message:
          type: string
        detail:
          type: string
      required:
      - errorCode
      - message
    ProductUserTransactionItem:
      type: object
      properties:
        userId:
          type: string
        orgId:
          type: string
          description: Present on a membership item, absent on the user itself.
        operation:
          type: string
          enum:
          - UPSERT_PRODUCT_USER
          - UPSERT_PRODUCT_USER_ORGANISATION_MAPPING
          - DELETE_PRODUCT_USER_ORGANISATION_MAPPING_SOURCE
        status:
          type: string
          enum:
          - CREATED
          - UPDATED
          - NO_CHANGE
          - DELETED
          - FAILED
        error:
          type: string
          description: Present only when this item failed.
    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
    OrganizationUsersInput:
      type: object
      properties:
        userIds:
          type: array
          items:
            type: string
          maxItems: 100
          minItems: 1
      required:
      - userIds
    OrganizationListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Organization'
        pagination:
          $ref: '#/components/schemas/Pagination'
        meta:
          $ref: '#/components/schemas/Meta'
    ProductUserTransactionResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ProductUserTransaction'
        meta:
          $ref: '#/components/schemas/Meta'
    OrganizationPatch:
      type: object
      minProperties: 1
      properties:
        name:
          type: string
          description: New display name. Omit to leave it unchanged.
        properties:
          type: object
          additionalProperties: true
          description: 'Properties to merge into the stored bag. Keys you omit are left as

            they are; a key matching one of your organization columns is written

            to that column too.

            '
      description: Supply at least one of `name` or `properties`.
    Organization:
      type: object
      properties:
        id:
          type: string
          description: Organization id
          as your product supplied it.: null
        properties:
          type: object
          additionalProperties: true
          description: 'Every remaining column of the stored row, keyed on its own name in

            snake_case, including the internal audit columns. `id` is not

            repeated here.

            '
      required:
      - id
    ProductUserTransaction:
      type: object
      properties:
        transactionId:
          type: string
        status:
          type: string
          enum:
          - PENDING
          - DONE
          - ERROR
          description: '`ERROR` means the write could not be queued and none of it was applied.

            '
        createdAt:
          type: string
          format: date-time
        results:
          type: array
          items:
            $ref: '#/components/schemas/ProductUserTransactionItem'
          description: Present once the transaction is no longer pending.
      required:
      - transactionId
      - status
    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.
    NotFound:
      description: 'The requested resource was not found (`errorCode: NOT_FOUND`).'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
  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
    PageNumber:
      name: pageNumber
      in: query
      required: false
      description: 1-based page number.
      schema:
        type: integer
        minimum: 1
        maximum: 2147483647
        default: 1
    OrganizationId:
      name: id
      in: path
      required: true
      description: Organization id, as your product supplied it. Max 100 characters.
      schema:
        type: string
        minLength: 1
        maxLength: 100
  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)