openapi: 3.2.0
info:
  title: allwhere Beta API
  version: '2026-10-05'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-05: 8 operation(s) read from 6 public documentation page(s) (each operation names its page in x-source). This is not the provider''s published contract; allwhere has published no machine-readable contract that the pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 12
    documentation: -4
    pages-with-code: 5
    pages-read: 6
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-05'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://docs.allwhere.co/docs/allwhere-api-use-cases.md
  - https://docs.allwhere.co/docs/quick-start-guide.md
  - https://docs.allwhere.co/docs/quick-start-guide
  - https://docs.allwhere.co/docs/allwhere-api-use-cases
  - https://docs.allwhere.co/docs/creating-a-p2r-order-helpful-hints
  - https://docs.allwhere.co/docs/rippling-create-and-update-employees-in-allwhere
servers:
- url: https://api.allwhere.co
security:
- bearer: []
tags:
- name: Beta
paths:
  /beta/assets/{assetid}:
    get:
      operationId: get_beta_assets_assetid
      tags:
      - Beta
      summary: GET /beta/assets/{assetId}
      x-source: https://docs.allwhere.co/docs/allwhere-api-use-cases.md
      parameters:
      - name: assetid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetBetaAssetsAssetidResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X GET \"https://api.allwhere.co/beta/assets/15678\"  -H \"Authorization: Bearer YOUR_API_KEY\"\n  ```\n</Accordion>"
  /beta/employees:
    patch:
      operationId: patch_beta_employees
      tags:
      - Beta
      summary: PATCH /beta/employees
      x-source: https://docs.allwhere.co/docs/allwhere-api-use-cases.md
      parameters:
      - name: workEmail
        in: query
        required: false
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchBetaEmployeesRequest'
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X PATCH \"https://api.allwhere.co/beta/employees?workEmail=john.doe@company.com\"  -H \"Authorization: Bearer YOUR_API_KEY\"  -H \"Content-Type: application/json\"  -d '{\n      \"employmentStatus\": \"INACTIVE\",\n      \"endDate\": \"2025-12-31T00:00:00.000Z\"\n    }'\n  ```\n</Accordion>"
    post:
      operationId: post_beta_employees
      tags:
      - Beta
      summary: POST /beta/employees
      x-source: https://docs.allwhere.co/docs/allwhere-api-use-cases.md
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostBetaEmployeesRequest'
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostBetaEmployeesResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X POST \"https://api.allwhere.co/beta/employees\"  -H \"Authorization: Bearer YOUR_API_KEY\"  -H \"Content-Type: application/json\"  -d '{\n      \"firstName\": \"John\",\n      \"lastName\": \"Doe\",\n      \"workEmail\": \"john.doe@company.com\",\n      \"phoneNumber\": \"+15559876543\",\n      \"employmentStatus\": \"ACTIVE\",\n      \"startDate\": \"2025-11-01T00:00:00.000Z\",\n      \"employeeNumber\": \"EMP-5678\",\n      \"hom"
  /beta/employees/batch:
    patch:
      operationId: patch_beta_employees_batch
      tags:
      - Beta
      summary: PATCH /beta/employees/batch
      x-source: https://docs.allwhere.co/docs/allwhere-api-use-cases.md
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchBetaEmployeesBatchRequest'
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PatchBetaEmployeesBatchResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X PATCH \"https://api.allwhere.co/beta/employees/batch\"  -H \"Authorization: Bearer YOUR_API_KEY\"  -H \"Content-Type: application/json\"  -d '{\n      \"employees\": [\n        {\n          \"lookupWorkEmail\": \"alice.wang@company.com\",\n          \"employmentStatus\": \"INACTIVE\",\n          \"endDate\": \"2025-12-31T00:00:00.000Z\"\n        },\n        {\n          \"lookupWorkEmail\": \"bob.chen@company.com\",\n    "
    post:
      operationId: post_beta_employees_batch
      tags:
      - Beta
      summary: POST /beta/employees/batch
      x-source: https://docs.allwhere.co/docs/allwhere-api-use-cases.md
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostBetaEmployeesBatchRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X POST \"https://api.allwhere.co/beta/employees/batch\"  -H \"Authorization: Bearer YOUR_API_KEY\"  -H \"Content-Type: application/json\"  -d '{\n      \"employees\": [\n        {\n          \"firstName\": \"Alice\",\n          \"lastName\": \"Wang\",\n          \"workEmail\": \"alice.wang@company.com\",\n          \"employmentStatus\": \"ACTIVE\",\n          \"startDate\": \"2025-11-01T00:00:00.000Z\"\n        },\n        {\n  "
  /beta/orders/15234-1-ACME:
    get:
      operationId: get_beta_orders_15234_1_ACME
      tags:
      - Beta
      summary: GET /beta/orders/15234-1-ACME
      x-source: https://docs.allwhere.co/docs/allwhere-api-use-cases.md
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetBetaOrders152341AcmeResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X GET \"https://api.allwhere.co/beta/orders/15234-1-ACME\"  -H \"Authorization: Bearer YOUR_API_KEY\"\n  ```\n</Accordion>"
  /beta/orders/{orderid}:
    post:
      operationId: post_beta_orders_orderid
      tags:
      - Beta
      summary: POST /beta/orders/deployment
      x-source: https://docs.allwhere.co/docs/allwhere-api-use-cases.md
      parameters:
      - name: orderid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostBetaOrdersOrderidRequest'
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostBetaOrdersOrderidResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X POST \"https://api.allwhere.co/beta/orders/deployment\"  -H \"Authorization: Bearer YOUR_API_KEY\"  -H \"Content-Type: application/json\"  -H \"X-Request-ID: deploy-jane-20251015\"  -d '{\n      \"purchaserEmail\": \"it-ops@company.com\",\n      \"serviceCountry\": \"UNITED_STATES\",\n      \"shippingType\": \"Standard\",\n      \"recipient\": {\n        \"firstName\": \"Jane\",\n        \"lastName\": \"Smith\",\n        \"wor"
        collapsed_from: 3 example path(s) differing only at orderId
  /beta/{betaid}:
    get:
      operationId: get_beta_betaid
      tags:
      - Beta
      summary: GET /beta/assets
      x-source: https://docs.allwhere.co/docs/allwhere-api-use-cases.md
      parameters:
      - name: betaid
        in: path
        required: true
        schema:
          type: string
      - name: assetType
        in: query
        required: false
        schema:
          type: string
      - name: limit
        in: query
        required: false
        schema:
          type: string
      - name: order
        in: query
        required: false
        schema:
          type: string
      - name: skip
        in: query
        required: false
        schema:
          type: string
      - name: status
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetBetaBetaidResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X GET \"https://api.allwhere.co/beta/assets?status=In_Inventory&assetType=Laptop&limit=20&skip=0&order=desc\"  -H \"Authorization: Bearer YOUR_API_KEY\"\n  ```\n</Accordion>"
        collapsed_from: 3 example path(s) differing only at betaId
components:
  schemas:
    PostBetaEmployeesResponse:
      type: object
      properties:
        id:
          type: string
        firstName:
          type: string
        lastName:
          type: string
        workEmail:
          type: string
        personalEmail:
          type:
          - string
          - 'null'
        preferredName:
          type:
          - string
          - 'null'
        phoneNumber:
          type: string
        employmentStatus:
          type: string
        group:
          type:
          - string
          - 'null'
        startDate:
          type: string
          format: date-time
        endDate:
          type:
          - string
          - 'null'
        hireDate:
          type:
          - string
          - 'null'
        birthday:
          type:
          - string
          - 'null'
        hrisEmployeeId:
          type:
          - string
          - 'null'
        employeeNumber:
          type: string
        homeAddress:
          type: object
          properties:
            streetAddress1:
              type: string
            streetAddress2:
              type:
              - string
              - 'null'
            city:
              type: string
            principalRegion:
              type: string
            zipCode:
              type: string
            country:
              type: string
        workAddress:
          type:
          - string
          - 'null'
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    PatchBetaEmployeesBatchRequest:
      type: object
      properties:
        employees:
          type: array
          items:
            type: object
            properties:
              lookupWorkEmail:
                type: string
              employmentStatus:
                type: string
              endDate:
                type: string
                format: date-time
    PostBetaOrdersOrderidResponse:
      type: object
      properties:
        orderNumber:
          type: string
        status:
          type: string
        purchaser:
          type: object
          properties:
            firstName:
              type: string
            lastName:
              type: string
            workEmail:
              type: string
        recipient:
          type: object
          properties:
            firstName:
              type: string
            lastName:
              type: string
            email:
              type: string
            phoneNumber:
              type: string
        orderItems:
          type: array
          items:
            type: object
            properties:
              orderItemNumber:
                type: string
              serialNumber:
                type: string
              quantity:
                type: integer
              unitPrice:
                type:
                - string
                - 'null'
              insuranceRequested:
                type: string
              processDevice:
                type:
                - string
                - 'null'
              shipment:
                type:
                - string
                - 'null'
              asset:
                type: object
                properties:
                  assetNumber:
                    type: string
                  make:
                    type: string
                  model:
                    type: string
              createdAt:
                type: string
                format: date-time
              updatedAt:
                type: string
                format: date-time
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    PostBetaEmployeesBatchRequest:
      type: object
      properties:
        employees:
          type: array
          items:
            type: object
            properties:
              firstName:
                type: string
              lastName:
                type: string
              workEmail:
                type: string
              employmentStatus:
                type: string
              startDate:
                type: string
                format: date-time
    PatchBetaEmployeesBatchResponse:
      type: object
      properties:
        Authorization:
          type: string
    PatchBetaEmployeesRequest:
      type: object
      properties:
        employmentStatus:
          type: string
        endDate:
          type: string
          format: date-time
    PostBetaOrdersOrderidRequest:
      type: object
      properties:
        purchaserEmail:
          type: string
        serviceCountry:
          type: string
        shippingType:
          type: string
        recipient:
          type: object
          properties:
            firstName:
              type: string
            lastName:
              type: string
            workEmail:
              type: string
            phoneNumber:
              type: string
            address:
              type: object
              properties:
                streetAddress1:
                  type: string
                city:
                  type: string
                principalRegion:
                  type: string
                zipCode:
                  type: string
                country:
                  type: string
                location:
                  type: string
        orderItems:
          type: array
          items:
            type: object
            properties:
              serialNumber:
                type: string
              insuranceRequested:
                type: string
        checkoutNotes:
          type: string
    GetBetaBetaidResponse:
      type: object
      properties:
        items:
          type: array
          items:
            type: object
            properties:
              assetNumber:
                type: string
              status:
                type: string
              serialNumber:
                type: string
              make:
                type: string
              model:
                type: string
              releaseYear:
                type: integer
              memory:
                type: string
              storage:
                type: string
              processor:
                type: string
              displaySize:
                type: string
              cosmeticCondition:
                type: string
              type:
                type: string
              assignee:
                type:
                - string
                - 'null'
              depot:
                type: object
                properties:
                  name:
                    type: string
                  displayName:
                    type: string
              orderHistory:
                type: array
                items: {}
              createdAt:
                type: string
                format: date-time
              updatedAt:
                type: string
                format: date-time
        pagination:
          type: object
          properties:
            total:
              type: integer
            skip:
              type: integer
            limit:
              type: integer
    GetBetaAssetsAssetidResponse:
      type: object
      properties:
        assetNumber:
          type: string
        status:
          type: string
        serialNumber:
          type: string
        make:
          type: string
        model:
          type: string
        releaseYear:
          type: integer
        color:
          type: string
        memory:
          type: string
        storage:
          type: string
        storageType:
          type: string
        processor:
          type: string
        processorFrequency:
          type: string
        displaySize:
          type: string
        keyboard:
          type: string
        operatingSystem:
          type: string
        cosmeticCondition:
          type: string
        type:
          type: string
        purchaseDate:
          type: string
          format: date-time
        warrantyExpiration:
          type: string
          format: date-time
        assignee:
          type: object
          properties:
            firstName:
              type: string
            lastName:
              type: string
            workEmail:
              type: string
            personalEmail:
              type:
              - string
              - 'null'
            employeeNumber:
              type: string
        depot:
          type: object
          properties:
            name:
              type: string
            displayName:
              type: string
        orderHistory:
          type: array
          items:
            type: string
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    PostBetaEmployeesRequest:
      type: object
      properties:
        firstName:
          type: string
        lastName:
          type: string
        workEmail:
          type: string
        phoneNumber:
          type: string
        employmentStatus:
          type: string
        startDate:
          type: string
          format: date-time
        employeeNumber:
          type: string
        homeAddress:
          type: object
          properties:
            streetAddress1:
              type: string
            city:
              type: string
            principalRegion:
              type: string
            zipCode:
              type: string
            country:
              type: string
    GetBetaOrders152341AcmeResponse:
      type: object
      properties:
        orderNumber:
          type: string
        status:
          type: string
        purchaser:
          type: object
          properties:
            firstName:
              type: string
            lastName:
              type: string
            workEmail:
              type: string
        recipient:
          type: object
          properties:
            firstName:
              type: string
            lastName:
              type: string
            email:
              type: string
            phoneNumber:
              type: string
        orderItems:
          type: array
          items:
            type: object
            properties:
              orderItemNumber:
                type: string
              serialNumber:
                type: string
              quantity:
                type: integer
              unitPrice:
                type:
                - string
                - 'null'
              insuranceRequested:
                type: string
              processDevice:
                type: boolean
              shipment:
                type: object
                properties:
                  status:
                    type: string
                  trackingNumbers:
                    type: array
                    items:
                      type: string
                  carrier:
                    type: string
              asset:
                type: object
                properties:
                  assetNumber:
                    type: string
                  make:
                    type: string
                  model:
                    type: string
              createdAt:
                type: string
                format: date-time
              updatedAt:
                type: string
                format: date-time
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
  securitySchemes:
    bearer:
      type: http
      scheme: bearer