freshworks Locations API

openapi: 3.2.0
info:
  title: Freshworks Freshservice Locations API
  description: The Freshservice API v2 is a RESTful API for managing IT service desk operations programmatically. It provides endpoints for tickets, problems, changes, releases, assets, requesters, agents, and other ITSM resources. The API supports Cross-Origin Resource Sharing (CORS) for web-based applications, uses API key authentication via Base64-encoded authorization headers, and allows organizations to automate IT service management workflows and integrate Freshservice with other enterprise tools.
  version: '2.0'
  contact:
    name: Freshworks Support
    url: https://support.freshservice.com/
  termsOfService: https://www.freshworks.com/terms/
servers:
- url: https://{domain}.freshservice.com/api/v2
  description: Freshservice Production Server
  variables:
    domain:
      default: yourdomain
      description: Your Freshservice subdomain
security:
- basicAuth: []
tags:
- name: Locations
  description: Manage office and facility locations.
paths:
  /locations:
    get:
      operationId: listLocations
      summary: List all locations
      description: Retrieves a list of all office and facility locations.
      tags:
      - Locations
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  locations:
                    type: array
                    items:
                      $ref: '#/components/schemas/Location'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    Error:
      type: object
      properties:
        description:
          type: string
          description: Human-readable error message.
        errors:
          type: array
          description: List of specific validation errors.
          items:
            type: object
            properties:
              field:
                type: string
                description: Field that caused the error.
              message:
                type: string
                description: Error message.
              code:
                type: string
                description: Error code.
    Location:
      type: object
      properties:
        id:
          type: integer
          description: Unique ID of the location.
        name:
          type: string
          description: Name of the location.
        address:
          type: object
          description: Address of the location.
          properties:
            line1:
              type: string
              description: Address line 1.
            line2:
              type: string
              description: Address line 2.
            city:
              type: string
              description: City.
            state:
              type: string
              description: State or province.
            country:
              type: string
              description: Country.
            zip_code:
              type: string
              description: Postal or ZIP code.
        contact:
          type: object
          description: Contact information.
          properties:
            name:
              type: string
              description: Contact name.
            phone:
              type: string
              description: Contact phone.
            email:
              type: string
              format: email
              description: Contact email.
        created_at:
          type: string
          format: date-time
          description: Timestamp when created.
        updated_at:
          type: string
          format: date-time
          description: Timestamp when last updated.
  responses:
    Unauthorized:
      description: Authentication credentials are missing or invalid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: Use your API key as the username and X as the password. The API key can be found in your Freshservice profile settings.
externalDocs:
  description: Freshservice API Documentation
  url: https://api.freshservice.com/