> ## Documentation Index
> Fetch the complete documentation index at: https://help.gorelo.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Lists the locations for a given client.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/clients/{clientId}/locations
openapi: 3.0.4
info:
  title: Public API
  description: Gorelo Public API documentation.
  version: 1.0.0
servers:
  - url: https://api.usw.gorelo.io
    description: US
  - url: https://api.aue.gorelo.io
    description: Australia
security:
  - ApiKeyAuth: []
tags:
  - name: Attachments
    description: "Uploading a file, for anything that can carry one. One endpoint rather than one per record\r\ntype, because the upload itself is identical - only the record it is checked against differs."
  - name: Alerts
    description: Alerts management operations
  - name: Assets
    description: Assets management operations
  - name: Billing
    description: Billing management operations
  - name: Tickets
    description: Tickets management operations
  - name: Clients
    description: Clients management operations
  - name: Contacts
    description: Contacts management operations
  - name: Deletions
    description: Deletions management operations
  - name: Documents
    description: Documents management operations
  - name: Forms
    description: Forms management operations
  - name: Organization
    description: Organization management operations
  - name: Projects
    description: Projects management operations
paths:
  /v1/clients/{clientId}/locations:
    get:
      tags:
        - Clients
      summary: Lists the locations for a given client.
      operationId: get_v1_clients_clientId_locations
      parameters:
        - name: clientId
          in: path
          description: Client identifier.
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ClientLocationResponseListBaseResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ClientLocationResponseListBaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ClientLocationResponseListBaseResponse'
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
        '401':
          description: Unauthorized
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
        '404':
          description: Not Found
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
        '500':
          description: Internal Server Error
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
components:
  schemas:
    ClientLocationResponseListBaseResponse:
      type: object
      properties:
        StatusCode:
          $ref: '#/components/schemas/HttpStatusCode'
        IsSuccess:
          type: boolean
        Data:
          type: array
          items:
            $ref: '#/components/schemas/ClientLocationResponse'
          nullable: true
        DataContext:
          type: object
          additionalProperties: false
          nullable: true
          example: null
        Notifications:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      additionalProperties: false
    ObjectBaseResponse:
      type: object
      properties:
        StatusCode:
          $ref: '#/components/schemas/HttpStatusCode'
        IsSuccess:
          type: boolean
        Data:
          nullable: true
        DataContext:
          $ref: '#/components/schemas/ErrorDataContext'
        Notifications:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      additionalProperties: false
    HttpStatusCode:
      enum:
        - 100
        - 101
        - 102
        - 103
        - 200
        - 201
        - 202
        - 203
        - 204
        - 205
        - 206
        - 207
        - 208
        - 226
        - 300
        - 301
        - 302
        - 303
        - 304
        - 305
        - 306
        - 307
        - 308
        - 400
        - 401
        - 402
        - 403
        - 404
        - 405
        - 406
        - 407
        - 408
        - 409
        - 410
        - 411
        - 412
        - 413
        - 414
        - 415
        - 416
        - 417
        - 421
        - 422
        - 423
        - 424
        - 426
        - 428
        - 429
        - 431
        - 451
        - 500
        - 501
        - 502
        - 503
        - 504
        - 505
        - 506
        - 507
        - 508
        - 510
        - 511
      type: integer
      format: int32
    ClientLocationResponse:
      type: object
      properties:
        Id:
          type: integer
          description: Location identifier.
          format: int64
        Name:
          type: string
          description: Location display name.
        ClientId:
          type: integer
          description: Identifier of the client this location belongs to.
          format: int64
        CreatedOn:
          type: string
          description: Creation timestamp (UTC).
          format: date-time
          nullable: true
        UpdatedOn:
          type: string
          description: Last-updated timestamp (UTC).
          format: date-time
          nullable: true
        PrimaryContactId:
          type: integer
          description: Identifier of the primary contact for the location.
          format: int64
          nullable: true
        PhoneCountryCode:
          type: string
          description: Phone ISO 3166-1 alpha-2 region code (e.g. US).
        Phone:
          type: string
          description: >-
            Phone number, as dialled within its country, e.g. 021 123 4567 for
            NZ.
        PhoneExt:
          type: string
          description: Phone extension.
        BillingContactIds:
          type: string
          description: Comma-separated identifiers of billing contacts.
        Address1:
          type: string
          description: Address line 1.
        Address2:
          type: string
          description: Address line 2.
        City:
          type: string
          description: City.
        State:
          type: string
          description: State / province.
        Country:
          type: string
          description: Country.
        PostalCode:
          type: string
          description: Postal / ZIP code.
        GeoLocationLatitude:
          type: number
          description: Geolocation latitude.
          format: double
          nullable: true
        GeoLocationLongitude:
          type: number
          description: Geolocation longitude.
          format: double
          nullable: true
        TimeZone:
          type: string
          description: IANA time zone identifier for the location.
        IsDefault:
          type: boolean
          description: Whether this is the client's default location.
          nullable: true
        IsDefaultBilling:
          type: boolean
          description: Whether this is the client's default billing location.
          nullable: true
      additionalProperties: false
      description: A client location. Timestamps are UTC.
    Error:
      type: object
      properties:
        Code:
          pattern: ^[0-9]{6}$
          type: string
          description: 6-digit MMTTNN error code. See the Public API error-code registry.
          example: '070101'
        Message:
          type: string
        PropertyName:
          type: string
          nullable: true
        ActionHint:
          type: string
          nullable: true
        DocUrl:
          type: string
          nullable: true
      additionalProperties: false
    ErrorDataContext:
      type: object
      properties:
        TraceId:
          type: string
          description: Request correlation id. Quote this when reporting a problem.
          nullable: true
      additionalProperties: false
      description: "The `DataContext` of an error response: carries the correlation id for the failed\r\nrequest."
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      description: >-
        Your Gorelo API key. See [Generate API key](/generate-api-key). If your
        data is hosted in Australia, click the base URL at the top of this page
        and select `https://api.aue.gorelo.io`.
      name: X-API-Key
      in: header

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.