Knit Locations API

Operations for managing location/office data.

OpenAPI Specification

knit-locations-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Knit Unified Departments Locations API
  description: Knit provides a unified API for B2B products, AI agents, and MCP clients to integrate with HR, recruitment, and collaboration tools. Knit handles cron jobs, rate limits, and retries for predictable data syncing at scale. The API provides standardized endpoints for accessing employee data, time-off, departments, locations, and more across multiple HRIS, ATS, and communication platforms.
  version: v1
  contact:
    name: Knit Developer Support
    url: https://developers.getknit.dev/
  license:
    name: Knit Terms of Service
    url: https://www.getknit.dev/terms
servers:
- url: https://api.getknit.dev/v1
  description: Knit API production endpoint
security:
- apiKey: []
tags:
- name: Locations
  description: Operations for managing location/office data.
paths:
  /locations:
    get:
      operationId: listLocations
      summary: List Locations
      description: Returns a list of office locations from connected integrations.
      tags:
      - Locations
      parameters:
      - name: integration_id
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: A list of locations.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Location'
        '401':
          description: Unauthorized.
components:
  schemas:
    Location:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        address:
          type: string
        city:
          type: string
        state:
          type: string
        country:
          type: string
        integration_id:
          type: string
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: Authorization
      description: API key authentication via Bearer token.