openapi: 3.0.3
info:
  title: TaskRabbit Partner Delivery Home Services Catalog API
  description: 'TaskRabbit''s Partner API program, documented at developer.taskrabbit.com, spans two live surfaces: the Home Services Partner Platform (versioned 2025-12) covering the Estimate, Availability, Bid, Book project workflow plus catalog and cancellation/reschedule management, and the Delivery API inherited from Dolly (acquired by TaskRabbit in November 2024 and rebranded TaskRabbit Delivery). Both surfaces require partner approval and Auth0 OAuth2 client-credentials (machine-to-machine) tokens; there is no public self-serve signup. Endpoint shapes below are modeled from TaskRabbit''s public developer documentation (method, path, and the parameters/fields the docs describe); exact request/response schemas are partially withheld behind the gated Postman collection and reference pages given to approved partners, so object schemas here are best-effort and marked accordingly rather than fabricated in full detail.'
  version: 2025-12
  contact:
    name: TaskRabbit Developer Hub
    url: https://developer.taskrabbit.com
  x-endpointsModeled: true
  x-accessModel: Partner-approval gated; no public self-serve signup.
servers:
- url: https://{api_subdomain}.partner-platform.taskrabbit.com/2025-12
  description: TaskRabbit Home Services Partner Platform (partner-specific subdomain, Sandbox and Production)
  variables:
    api_subdomain:
      default: your-subdomain
      description: Subdomain issued to the partner during onboarding.
- url: https://papi.dolly.com/v1
  description: TaskRabbit Delivery (Dolly) Partner API - Production
- url: https://papi.sandbox.dolly.com/v1
  description: TaskRabbit Delivery (Dolly) Partner API - Sandbox
security:
- oauth2: []
tags:
- name: Home Services Catalog
  description: Partner brand service catalog for Home Services.
paths:
  /brands/{brand_uuid}/services:
    get:
      operationId: listServicesByBrandUuid
      tags:
      - Home Services Catalog
      summary: List Services by Brand
      description: Retrieves all services configured for a partner brand, including names, pricing, and requirements.
      parameters:
      - name: brand_uuid
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: include_pricing
        in: query
        schema:
          type: boolean
          default: true
      - name: external_identifier
        in: query
        schema:
          type: string
      - name: locale
        in: query
        schema:
          type: string
          enum:
          - en-US
      responses:
        '200':
          description: The brand's service catalog.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Service'
  /services/{service_uuid}/external-identifier:
    put:
      operationId: updateServiceExternalIdentifier
      tags:
      - Home Services Catalog
      summary: Update Service External Identifier
      description: Updates a service's partner-defined external identifier for catalog reconciliation.
      parameters:
      - name: service_uuid
        in: path
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - external_identifier
              properties:
                external_identifier:
                  type: string
      responses:
        '200':
          description: Service updated.
components:
  schemas:
    Service:
      type: object
      properties:
        service_uuid:
          type: string
          format: uuid
        name:
          type: string
        external_identifier:
          type: string
        pricing:
          type: object
  securitySchemes:
    oauth2:
      type: oauth2
      description: Auth0 machine-to-machine (M2M) OAuth2 client-credentials grant. Credentials are issued during partner onboarding.
      flows:
        clientCredentials:
          tokenUrl: https://taskrabbit.auth0.com/oauth/token
          scopes: {}