openapi: 3.0.3
info:
  title: TaskRabbit Partner Delivery Home Services Estimate 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 Estimate
  description: Pricing and eligibility estimation for Home Services projects.
paths:
  /projects/estimate:
    post:
      operationId: estimateProject
      tags:
      - Home Services Estimate
      summary: Estimate Services
      description: Returns service eligibility and a price estimate for a given postal code or full address and one or more requested services. The first call in the Estimate, Availability, Bid, Book sequence.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EstimateRequest'
      responses:
        '201':
          description: Estimated pricing for the requested services.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EstimateResponse'
        '400':
          description: Invalid estimate request parameters.
components:
  schemas:
    Location:
      type: object
      properties:
        postal_code:
          type: string
        address:
          type: string
    EstimateRequest:
      type: object
      required:
      - locale
      - currency
      - location
      - services
      properties:
        locale:
          type: string
          enum:
          - en-US
        currency:
          type: string
          enum:
          - USD
        location:
          $ref: '#/components/schemas/Location'
        services:
          type: array
          items:
            $ref: '#/components/schemas/ServiceItemRequest'
    EstimateResponse:
      type: object
      description: Service eligibility and price estimate; exact response shape not published outside partner materials.
      properties:
        eligible:
          type: boolean
        estimated_price_cents:
          type: integer
    ServiceItemRequest:
      type: object
      description: A requested service line item; exact field list beyond category/quantity is not published outside partner materials.
      properties:
        service_id:
          type: string
        quantity:
          type: integer
  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: {}