Zuper Authentication API

openapi: 3.0.3
info:
  title: Zuper REST Assets Authentication API
  description: The Zuper REST API provides programmatic access to the Zuper field service management platform. It covers jobs, scheduling, route optimization, customers, organizations, assets, inventory, purchase orders, invoices, proposals, quotes, timesheets, projects, properties, service tasks, service contracts, webhooks, and communications. Authentication uses API keys passed via the x-api-key header. Region-specific base URLs are discovered by POSTing to the accounts endpoint.
  version: 1.0.0
  contact:
    name: Zuper Developer Support
    url: https://developers.zuper.co/discuss
  x-api-evangelist-ratings:
    design: 7
    consistency: 7
    documentation: 8
servers:
- url: https://{dc_region}.zuperpro.com/api
  description: Region-specific API server (dc_region obtained from accounts endpoint)
  variables:
    dc_region:
      default: us1
      description: Data-center region identifier returned by the config endpoint
- url: https://accounts.zuperpro.com/api
  description: Accounts / configuration endpoint
security:
- ApiKeyAuth: []
tags:
- name: Authentication
  description: API key generation and base URL discovery
paths:
  /config:
    post:
      summary: Get Region-Specific Base URL
      operationId: getConfig
      description: POST your company login name to discover the dc_api_url (region-specific base URL) for all subsequent API calls. Must target https://accounts.zuperpro.com/api.
      tags:
      - Authentication
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - company_login
              properties:
                company_login:
                  type: string
                  description: Your Zuper company login name
      responses:
        '200':
          description: Configuration details including dc_api_url
          content:
            application/json:
              schema:
                type: object
                properties:
                  dc_api_url:
                    type: string
                    description: Region-specific base API URL to use for all subsequent requests
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: API key generated from Zuper Settings > Developer Hub > API Keys