> ## Documentation Index
> Fetch the complete documentation index at: https://docs.01advertising.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Describe an integration provider

> The provider's settings and connect fields as data, so a client knows what to send before creating or connecting an integration (ADR-0050). An unknown id is a validation failure that lists the known ids.



## OpenAPI

````yaml /api/openapi.json get /v1/integrations/providers/{provider}
openapi: 3.1.0
info:
  title: 01Advertising Platform API
  version: 0.1.0
  description: >-
    HTTP API of the 01Advertising Platform: organizations, workspaces, API keys,
    audit logs, and the integrations that connect workspaces to advertising
    systems.


    ## Base URL and versions


    Production is `https://api.01ads.com`. Business endpoints live under `/v1`;
    `/health`, `/version`, and `/openapi.json` are unversioned. Before 1.0,
    breaking changes are made in place under `/v1` and shipped together with the
    Portal and CLI; from 1.0 on, a breaking change becomes a `/v2` sibling.
    Operation ids and schema names are stable identifiers. Local development
    runs at `http://127.0.0.1:3000` (`make api`).


    ## Authentication


    Three ways in, declared as security schemes and on every operation: a
    **session cookie** (browsers, set by the sign-in routes), the same session
    as **`Authorization: Bearer`** (the CLI and scripts), or an
    organization-bound **API key** as `x-api-key` (integrations and automation).
    Operations that declare no security requirement are public; operations that
    list only the two session schemes refuse API keys — administrative and
    account changes stay with people.


    ## Errors


    Every non-2xx answer is `application/problem+json` (RFC 9457): `type`,
    `title`, `status`, `detail`, `instance`, and `requestId`; validation
    failures add `errors: [{ path, message }]`. Browser flows answer 302 with no
    body.


    ## Collections, rate limits, and system administration


    Collections are returned whole; `GET /v1/organizations/{orgSlug}/audit-logs`
    is cursor-paginated (`cursor`, `limit`, `nextCursor`). Sign-in emails and
    sign-ups are limited per client address and per email, invitations created
    through an API key per key, and the public connect flow per address and per
    token: a limited request answers 429 with `Retry-After` in seconds.


    Guides, playbooks, and the embedding walkthrough:
    https://docs.01advertising.com.
  termsOfService: https://www.01advertising.com/legal/terms/
  contact:
    name: 01Advertising API support
    email: support@01advertising.com
    url: https://docs.01advertising.com
  license:
    name: Proprietary
    url: https://www.01advertising.com/legal/terms/
servers:
  - url: https://api.01ads.com
    description: Production
security:
  - bearerAuth: []
  - apiKey: []
tags:
  - name: account
    description: The caller's own profile, sign-up, and the invitations addressed to them
    externalDocs:
      url: https://docs.01advertising.com/guides/account
      description: Account guide
  - name: auth
    description: Sign-in methods, magic links, provider sign-in, sessions, and sign-out
    externalDocs:
      url: https://docs.01advertising.com/guides/auth
      description: Authentication guide
  - name: organizations
    description: Organization membership and invitation management
    externalDocs:
      url: https://docs.01advertising.com/guides/organizations
      description: Organizations guide
  - name: workspaces
    description: 'Workspaces: isolated partitions within an organization'
    externalDocs:
      url: https://docs.01advertising.com/guides/workspaces
      description: Workspaces guide
  - name: api-keys
    description: Programmatic access credentials
    externalDocs:
      url: https://docs.01advertising.com/guides/api-keys
      description: API keys guide
  - name: audit
    description: Organization audit trail (cursor-paginated)
    externalDocs:
      url: https://docs.01advertising.com/guides/audit-logs
      description: Audit log guide
  - name: integrations
    description: Workspace integrations with external advertising systems
    externalDocs:
      url: https://docs.01advertising.com/guides/integrations
      description: Integrations guide
  - name: connect
    description: >-
      The public connect flow a client uses to authorize an integration (no
      session)
    externalDocs:
      url: https://docs.01advertising.com/guides/integrations-embedding
      description: Embedding the connect flow
  - name: infra
    description: Health, build information, and this document
    externalDocs:
      url: https://docs.01advertising.com/guides/api-conventions
      description: API conventions
externalDocs:
  url: https://docs.01advertising.com
  description: Developer documentation
paths:
  /v1/integrations/providers/{provider}:
    get:
      tags:
        - integrations
      summary: Describe an integration provider
      description: >-
        The provider's settings and connect fields as data, so a client knows
        what to send before creating or connecting an integration (ADR-0050). An
        unknown id is a validation failure that lists the known ids.
      operationId: describeIntegrationProvider
      parameters:
        - schema:
            type: string
            enum:
              - the_trade_desk
              - amazon_dsp
              - walmart_dsp
              - beeswax
              - google_dv360
              - openx
              - google_ad_manager
              - google_ads
              - meta
              - tiktok
              - snapchat
              - x
              - reddit
              - openai_ads
              - roku
              - iqm
              - yahoo_dsp
              - mediamath
              - linkedin
              - pinterest
          required: true
          name: provider
          in: path
      responses:
        '200':
          description: The provider, its field specs, and its instructions
          content:
            application/json:
              examples:
                theTradeDesk:
                  summary: A credentials provider
                  value:
                    id: the_trade_desk
                    name: The Trade Desk
                    category: dsp
                    authMethod: credentials
                    availability: available
                    stage: available
                    settingsFields:
                      - key: ttdUrl
                        label: Data endpoint URL
                        type: url
                        required: false
                        secret: false
                        default: https://usw-data.adsrvr.org/data/advertiser
                        help: The first-party data endpoint of the advertiser.
                    connectFields:
                      - key: advertiserId
                        label: Advertiser id
                        type: text
                        required: true
                        secret: true
                      - key: advertiserKey
                        label: Advertiser key
                        type: password
                        required: true
                        secret: true
                    instructions: >-
                      1. In The Trade Desk, open the advertiser and note its
                      **Advertiser id** and **Advertiser key**.
                    docsUrl: >-
                      https://partner.thetradedesk.com/v3/portal/data/doc/DataFirstPartyOverview
              schema:
                $ref: '#/components/schemas/IntegrationProviderDetail'
        '401':
          description: Not authenticated
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              examples:
                unauthorized:
                  summary: No usable credential
                  value:
                    type: about:blank
                    title: Unauthorized
                    status: 401
                    detail: Authentication required. Sign in and try again.
                    instance: /v1/organizations
                    requestId: 2f6a9c3d-1e4b-4a8c-b7d2-5e0f1a2b3c4d
components:
  schemas:
    IntegrationProviderDetail:
      type: object
      properties:
        id:
          type: string
          enum:
            - the_trade_desk
            - amazon_dsp
            - walmart_dsp
            - beeswax
            - google_dv360
            - openx
            - google_ad_manager
            - google_ads
            - meta
            - tiktok
            - snapchat
            - x
            - reddit
            - openai_ads
            - roku
            - iqm
            - yahoo_dsp
            - mediamath
            - linkedin
            - pinterest
          examples:
            - google_ads
        name:
          type: string
          examples:
            - Google Ads
        category:
          type: string
          enum:
            - dsp
            - ssp
            - wg
        authMethod:
          type: string
          enum:
            - oauth
            - credentials
        availability:
          type: string
          enum:
            - available
            - not_configured
            - coming_soon
          description: >-
            Whether integrations can be created here: `available`;
            `not_configured` when this platform lacks the OAuth application or
            developer token the provider needs; `coming_soon` for catalog
            placeholders
        stage:
          type: string
          enum:
            - available
            - coming_soon
          description: '`available`, or `coming_soon` for a catalog placeholder'
        settingsFields:
          type: array
          items:
            $ref: '#/components/schemas/ProviderField'
          description: >-
            What `settings` accepts on `POST …/integrations` and `PATCH
            …/integrations/{id}`; never secret
        connectFields:
          type: array
          items:
            $ref: '#/components/schemas/ProviderField'
          description: >-
            What the connecting party enters: the body of `POST
            …/integrations/{id}/credentials` for a credentials provider; the
            fields asked before consent (`POST …/integrations/{id}/oauth` or the
            connect page) for an OAuth provider
        instructions:
          type: string
          description: Markdown shown to the connecting party
        docsUrl:
          type: string
      required:
        - id
        - name
        - category
        - authMethod
        - availability
        - stage
        - settingsFields
        - connectFields
    Problem:
      type: object
      properties:
        type:
          type: string
          examples:
            - about:blank
        title:
          type: string
          examples:
            - Unauthorized
        status:
          type: integer
          examples:
            - 401
        detail:
          type: string
        instance:
          type: string
          examples:
            - /v1/me
        requestId:
          type: string
        errors:
          type: array
          items:
            type: object
            properties:
              path:
                type: string
              message:
                type: string
            required:
              - path
              - message
          description: Field-level problems of a validation failure
      required:
        - type
        - title
        - status
        - instance
    ProviderField:
      type: object
      properties:
        key:
          type: string
          examples:
            - customerId
          description: The JSON key, used verbatim
        label:
          type: string
          examples:
            - Customer account id
        type:
          type: string
          enum:
            - text
            - password
            - textarea
            - json
            - number
            - url
            - select
        required:
          type: boolean
        secret:
          type: boolean
          description: Sealed into the credentials and never returned by any API
        help:
          type: string
        placeholder:
          type: string
        pattern:
          type: string
          description: Regular-expression source the value must match
        maxLength:
          type: integer
        options:
          type: array
          items:
            type: object
            properties:
              value:
                type: string
              label:
                type: string
            required:
              - value
              - label
          description: The choices of a `select` field
        default:
          type: string
          description: Applied when the field is omitted
      required:
        - key
        - label
        - type
        - required
        - secret
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Session token as `Authorization: Bearer` (the CLI and scripts).'
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Organization-bound API key; accepted on /v1 routes other than
        /v1/auth/*.

````