Outreach2day Domains API

The Domains API from Outreach2day — 8 operation(s) for domains.

GitHub OpenAPI

Operations 10

GET /domains List Domains #
PATCH /domains/redirects Update Domains Redirects #
GET /domains/{domain}/dns Get Dns Records #
POST /domains/{domain}/dns Update Dns Records #
POST /check_domains Check Domains #
POST /domains/purchase Purchase Domains #
POST /domains/transfer/checkout Start Cloudflare domain transfer flow #
POST /domains/transfer Start Cloudflare domain transfer flow #
GET /domains/transfer Get Cloudflare transfer status for workspace domains #
GET /domains/transfer/status Get Cloudflare transfer status for workspace domains #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/outreach2day-com:outreach2day-com-domains-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

outreach2day-com-domains-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Outreach2day Com Domains API
  version: v1
  description: 'Operations tagged Domains across 2 of this provider''s published API definitions: public.json, outreach2day-com-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://public.outreach2day.com
  description: Production
tags:
- name: Domains
paths:
  /domains:
    get:
      tags:
      - Domains
      summary: List Domains
      description: 'List all domains for a user or a specific workspace.


        - If workspace_id is provided, it will return domains for that specific workspace.

        - If workspace_id is not provided, it will return domains for all workspaces of the user.'
      operationId: list_domains_domains_get
      security:
      - HTTPBearer: []
      parameters:
      - name: workspace_id
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          title: Workspace Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DomainInfo'
                title: Response List Domains Domains Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      servers:
      - url: https://public.outreach2day.com
        description: Production
    servers:
    - url: https://public.outreach2day.com
      description: Production
  /domains/redirects:
    patch:
      tags:
      - Domains
      summary: Update Domains Redirects
      description: 'Bulk update redirect_domain for workspace domains.


        Provider-specific redirect infrastructure is reconciled automatically.'
      operationId: update_domains_redirects_domains_redirects_patch
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PublicDomainRedirectsUpdateIn'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
      servers:
      - url: https://public.outreach2day.com
        description: Production
    servers:
    - url: https://public.outreach2day.com
      description: Production
  /domains/{domain}/dns:
    get:
      tags:
      - Domains
      summary: Get Dns Records
      description: Temporarily disabled to protect upstream DNS provider rate limits.
      operationId: get_dns_records_domains__domain__dns_get
      security:
      - HTTPBearer: []
      parameters:
      - name: domain
        in: path
        required: true
        schema:
          type: string
          title: Domain
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DNSRecord'
                title: Response Get Dns Records Domains  Domain  Dns Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      servers:
      - url: https://public.outreach2day.com
        description: Production
    post:
      tags:
      - Domains
      summary: Update Dns Records
      description: Update DNS records for a specific domain.
      operationId: update_dns_records_domains__domain__dns_post
      security:
      - HTTPBearer: []
      parameters:
      - name: domain
        in: path
        required: true
        schema:
          type: string
          title: Domain
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/UpdateDNSRecordRequest'
              title: Records
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      servers:
      - url: https://public.outreach2day.com
        description: Production
    servers:
    - url: https://public.outreach2day.com
      description: Production
  /check_domains:
    post:
      tags:
      - Domains
      summary: Check Domains
      description: Check availability of multiple domains.
      operationId: check_domains_check_domains_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CheckDomainsIn'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CheckDomainsOut'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
      servers:
      - url: https://public.outreach2day.com
        description: Production
    servers:
    - url: https://public.outreach2day.com
      description: Production
  /domains/purchase:
    post:
      tags:
      - Domains
      summary: Purchase Domains
      description: 'Purchase domains for a workspace via API.


        Prerequisites:

        - Workspace must have a saved payment method (via Stripe subscription)

        - All domains must be available for registration

        - Registrant contact info (`contact_info`) is required


        Guardrails: at most `PUBLIC_DOMAIN_PURCHASE_MAX_DOMAINS_PER_CALL` domains

        per call (default 10, over -> 400). An optional rolling-24h spend cap per

        workspace (`PUBLIC_DOMAIN_PURCHASE_DAILY_CAP_CENTS`, over -> 429) is off

        by default.

        Send an `Idempotency-Key` header to make retries safe.


        The payment is charged immediately using the saved payment method.'
      operationId: purchase_domains_domains_purchase_post
      security:
      - HTTPBearer: []
      parameters:
      - name: dryRun
        in: query
        required: false
        schema:
          type: boolean
          description: Validate and price the order without charging or registering anything.
          default: false
          title: Dryrun
        description: Validate and price the order without charging or registering anything.
      - name: Idempotency-Key
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Recommended. Same key + same body within 24h returns the first response without a second charge; same key + different body -> 409.
          title: Idempotency-Key
        description: Recommended. Same key + same body within 24h returns the first response without a second charge; same key + different body -> 409.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DomainPurchaseRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DomainPurchaseResponse'
        '402':
          description: Payment required. Create a quote (POST /v2/quotes), show it to the human and let them pay on the Stripe page; nothing was charged.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentRequiredOut'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      servers:
      - url: https://public.outreach2day.com
        description: Production
    servers:
    - url: https://public.outreach2day.com
      description: Production
  /domains/transfer/checkout:
    post:
      tags:
      - Domains
      summary: Start Cloudflare domain transfer flow
      description: 'Validate and enqueue domains for the transfer flow.


        Transfer itself is free in this flow: we persist domains as `pending_transfer`

        and return the nameservers to set at the registrar via `/domains/transfer/status`.'
      operationId: transfer_domains_checkout_domains_transfer_checkout_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TransferCheckoutRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicTransferCheckoutResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
      servers:
      - url: https://public.outreach2day.com
        description: Production
    servers:
    - url: https://public.outreach2day.com
      description: Production
  /domains/transfer:
    post:
      tags:
      - Domains
      summary: Start Cloudflare domain transfer flow
      description: 'Alias endpoint for transfer checkout.


        Keeps backward compatibility for clients/LLMs that expect `/domains/transfer`

        as the primary transfer entrypoint.'
      operationId: transfer_domains_checkout_alias_domains_transfer_post
      security:
      - HTTPBearer: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TransferCheckoutRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicTransferCheckoutResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      servers:
      - url: https://public.outreach2day.com
        description: Production
    get:
      tags:
      - Domains
      summary: Get Cloudflare transfer status for workspace domains
      description: Alias endpoint for transfer status polling.
      operationId: get_transfer_domains_status_alias_domains_transfer_get
      security:
      - HTTPBearer: []
      parameters:
      - name: workspaceId
        in: query
        required: true
        schema:
          type: integer
          title: Workspaceid
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransferStatusResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      servers:
      - url: https://public.outreach2day.com
        description: Production
    servers:
    - url: https://public.outreach2day.com
      description: Production
  /domains/transfer/status:
    get:
      tags:
      - Domains
      summary: Get Cloudflare transfer status for workspace domains
      description: Return per-domain transfer progress for Cloudflare-managed transfer flow.
      operationId: get_transfer_domains_status_domains_transfer_status_get
      security:
      - HTTPBearer: []
      parameters:
      - name: workspaceId
        in: query
        required: true
        schema:
          type: integer
          title: Workspaceid
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransferStatusResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      servers:
      - url: https://public.outreach2day.com
        description: Production
    servers:
    - url: https://public.outreach2day.com
      description: Production
components:
  schemas:
    PublicDomainRedirectsUpdateIn:
      properties:
        workspaceId:
          type: integer
          title: Workspaceid
        domains:
          items:
            type: string
          type: array
          title: Domains
        redirectDomain:
          type: string
          title: Redirectdomain
      type: object
      required:
      - workspaceId
      - redirectDomain
      title: PublicDomainRedirectsUpdateIn
    PaymentRequiredOut:
      properties:
        detail:
          $ref: '#/components/schemas/PaymentRequiredDetail'
      type: object
      required:
      - detail
      title: PaymentRequiredOut
    PublicTransferCheckoutResponse:
      properties:
        domainsCount:
          type: integer
          title: Domainscount
        nextUrl:
          type: string
          title: Nexturl
        nextStep:
          type: string
          title: Nextstep
        skipped:
          items:
            $ref: '#/components/schemas/SkippedDomain'
          type: array
          title: Skipped
      type: object
      required:
      - domainsCount
      - nextUrl
      - nextStep
      title: PublicTransferCheckoutResponse
      description: 'Public API (API key) answer to a transfer checkout.


        Transfer is free, so there is nothing to pay. ``nextUrl`` is the

        public endpoint to poll for nameservers and progress.'
    DomainPurchaseRequest:
      properties:
        workspace_id:
          type: integer
          title: Workspace Id
          description: Workspace ID where domains should be created
        domains:
          items:
            type: string
          type: array
          title: Domains
          description: List of root domains to purchase
        contact_info:
          anyOf:
          - $ref: '#/components/schemas/DomainPurchaseContactInfo'
          - type: 'null'
          description: 'Registrant contact info for domain registration. Required: the request is rejected with 422 CONTACT_INFO_REQUIRED without it. If email_address is omitted, API key owner''s email is used.'
      type: object
      required:
      - workspace_id
      - domains
      title: DomainPurchaseRequest
      description: Request model for domain purchase.
    DomainAvailabilityStatus:
      type: string
      enum:
      - free
      - taken
      - not_allowed
      - unknown
      title: DomainAvailabilityStatus
    DomainPurchaseResponse:
      properties:
        status:
          type: string
          title: Status
        message:
          type: string
          title: Message
        domains_purchased:
          items:
            type: string
          type: array
          title: Domains Purchased
        total_charged_cents:
          type: integer
          title: Total Charged Cents
        invoice_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Invoice Id
        estimated_total_cents:
          anyOf:
          - type: integer
          - type: 'null'
          title: Estimated Total Cents
      type: object
      required:
      - status
      - message
      - domains_purchased
      - total_charged_cents
      title: DomainPurchaseResponse
      description: Response model for domain purchase.
    DomainInfo:
      properties:
        id:
          type: integer
          title: Id
        user_id:
          anyOf:
          - type: integer
          - type: 'null'
          title: User Id
        domain:
          anyOf:
          - type: string
          - type: 'null'
          title: Domain
        status:
          anyOf:
          - type: string
          - type: 'null'
          title: Status
          default: init
        mailboxes_count:
          type: integer
          title: Mailboxes Count
          default: 0
        redirect_domain:
          anyOf:
          - type: string
          - type: 'null'
          title: Redirect Domain
        contact_info:
          anyOf:
          - type: string
          - type: 'null'
          title: Contact Info
        workspace_id:
          anyOf:
          - type: integer
          - type: 'null'
          title: Workspace Id
      type: object
      required:
      - id
      - user_id
      - domain
      - redirect_domain
      - contact_info
      - workspace_id
      title: DomainInfo
    UpdateDNSRecordRequest:
      properties:
        host:
          type: string
          title: Host
        type:
          type: string
          title: Type
        address:
          type: string
          title: Address
        ttl:
          type: integer
          title: Ttl
      type: object
      required:
      - host
      - type
      - address
      - ttl
      title: UpdateDNSRecordRequest
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    DomainAvailability:
      properties:
        domain:
          type: string
          title: Domain
        status:
          $ref: '#/components/schemas/DomainAvailabilityStatus'
      type: object
      required:
      - domain
      - status
      title: DomainAvailability
    CheckDomainsIn:
      properties:
        domains:
          items:
            type: string
          type: array
          maxItems: 100
          title: Domains
        workspaceId:
          anyOf:
          - type: integer
          - type: 'null'
          title: Workspaceid
      type: object
      required:
      - domains
      title: CheckDomainsIn
    TransferDomainStatus:
      properties:
        domain:
          type: string
          title: Domain
        status:
          type: string
          title: Status
        nameservers:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Nameservers
        zoneActive:
          type: boolean
          title: Zoneactive
          default: false
        errorMessage:
          anyOf:
          - type: string
          - type: 'null'
          title: Errormessage
        setupStage:
          anyOf:
          - type: string
          - type: 'null'
          title: Setupstage
        dnsReady:
          type: boolean
          title: Dnsready
          default: false
      type: object
      required:
      - domain
      - status
      title: TransferDomainStatus
    PaymentRequiredDetail:
      properties:
        error:
          type: string
          title: Error
          description: Stable error code, unchanged from earlier versions (e.g. PAYMENT_METHOD_REQUIRED, PAYMENT_SUBSCRIPTION_REQUIRED, PAYMENT_REQUIRED, MAILBOXES_LIMIT_REACHED).
        message:
          type: string
          title: Message
        next_action:
          type: string
          title: Next Action
          description: Always `create_quote`.
          default: create_quote
        next_step:
          type: string
          title: Next Step
        links:
          $ref: '#/components/schemas/PaymentRequiredLinks'
      additionalProperties: true
      type: object
      required:
      - error
      - message
      - next_step
      - links
      title: PaymentRequiredDetail
    DomainPurchaseContactInfo:
      properties:
        first_name:
          type: string
          title: First Name
          description: Registrant first name
          examples:
          - John
        last_name:
          type: string
          title: Last Name
          description: Registrant last name
          examples:
          - Doe
        real_address:
          type: string
          title: Real Address
          description: Street address
          examples:
          - 123 Main St
        city:
          type: string
          title: City
          description: City
          examples:
          - Austin
        state_province:
          type: string
          title: State Province
          description: State/Province
          examples:
          - Texas
        postal_code:
          type: string
          title: Postal Code
          description: Postal code
          examples:
          - '78701'
        country:
          type: string
          title: Country
          description: Country
          examples:
          - United States
        phone:
          type: string
          title: Phone
          description: Phone in international format
          examples:
          - '+15551234567'
        email_address:
          anyOf:
          - type: string
            format: email
          - type: 'null'
          title: Email Address
          description: Registrant email address
          examples:
          - john@acme.com
        organization_name:
          type: string
          title: Organization Name
          description: Organization name
          examples:
          - ACME Inc
        job_title:
          type: string
          title: Job Title
          description: Job title
          examples:
          - Founder
      type: object
      required:
      - first_name
      - last_name
      - real_address
      - city
      - state_province
      - postal_code
      - country
      - phone
      - organization_name
      - job_title
      title: DomainPurchaseContactInfo
      description: Registrant contact details used by registrar during domain purchase.
    SkippedDomain:
      properties:
        domain:
          type: string
          title: Domain
        reason:
          type: string
          title: Reason
      type: object
      required:
      - domain
      - reason
      title: SkippedDomain
      description: 'A requested domain that was not connected, and why.


        ``reason`` is ``already_connected`` (already in this workspace) or

        ``exists_elsewhere`` (held by another workspace).'
    TransferCheckoutRequest:
      properties:
        domains:
          items:
            type: string
          type: array
          title: Domains
        redirectDomain:
          type: string
          title: Redirectdomain
        workspaceId:
          type: integer
          title: Workspaceid
        isTest:
          type: boolean
          title: Istest
          default: false
      type: object
      required:
      - domains
      - redirectDomain
      - workspaceId
      title: TransferCheckoutRequest
    CheckDomainsOut:
      properties:
        domains:
          items:
            $ref: '#/components/schemas/DomainAvailability'
          type: array
          title: Domains
      type: object
      required:
      - domains
      title: CheckDomainsOut
    PaymentRequiredLinks:
      properties:
        pricing:
          type: string
          title: Pricing
        quote_api:
          type: string
          title: Quote Api
        docs:
          type: string
          title: Docs
      type: object
      required:
      - pricing
      - quote_api
      - docs
      title: PaymentRequiredLinks
    DNSRecord:
      properties:
        host:
          type: string
          title: Host
        type:
          type: string
          title: Type
        address:
          type: string
          title: Address
        ttl:
          type: integer
          title: Ttl
      type: object
      required:
      - host
      - type
      - address
      - ttl
      title: DNSRecord
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    TransferStatusResponse:
      properties:
        domains:
          items:
            $ref: '#/components/schemas/TransferDomainStatus'
          type: array
          title: Domains
      type: object
      required:
      - domains
      title: TransferStatusResponse
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
x-refined-from:
- public.json
- outreach2day-com-openapi.json
x-provenance:
  method: harvested
  publisher: Outreach2day
  source: https://public.outreach2day.com/openapi.json
  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)