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

# List locations



## OpenAPI

````yaml /api-reference/chataigne-v1.json get /v1/locations
openapi: 3.0.0
info:
  title: Chataigne API
  description: The Chataigne API — Location & Organization Management.
  version: '2026-05-01'
  contact: {}
servers:
  - url: https://api.chataigne.ai
security: []
tags: []
paths:
  /v1/locations:
    get:
      tags:
        - Locations
      summary: List locations
      operationId: LocationsV1Controller_list
      parameters:
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 10
          description: Page size (1–100).
        - name: starting_after
          in: query
          required: false
          schema:
            type: string
          description: 'Cursor: return results after this id.'
        - name: ending_before
          in: query
          required: false
          schema:
            type: string
          description: 'Cursor: return results before this id.'
        - name: created_after
          in: query
          required: false
          schema:
            type: string
            format: date-time
          description: Only resources created strictly after this time.
        - name: created_before
          in: query
          required: false
          schema:
            type: string
            format: date-time
          description: Only resources created strictly before this time.
        - name: updated_after
          in: query
          required: false
          schema:
            type: string
            format: date-time
          description: Only resources updated strictly after this time.
        - name: updated_before
          in: query
          required: false
          schema:
            type: string
            format: date-time
          description: Only resources updated strictly before this time.
      responses:
        '200':
          description: A paginated list of locations.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LocationList'
        '401':
          description: Authentication required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: The principal is not allowed to perform this request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - organization-api-key: []
components:
  schemas:
    LocationList:
      type: object
      properties:
        object:
          type: string
          enum:
            - list
        data:
          type: array
          items:
            $ref: '#/components/schemas/Location'
        has_more:
          type: boolean
        url:
          type: string
    Error:
      type: object
      properties:
        error:
          type: object
          required:
            - type
            - code
            - message
            - request_id
          properties:
            type:
              type: string
              enum:
                - invalid_request_error
                - authentication_error
                - authorization_error
                - not_found_error
                - conflict_error
                - rate_limit_error
                - idempotency_error
                - api_error
            code:
              type: string
              example: resource_missing
            message:
              type: string
            param:
              type: string
            request_id:
              type: string
              example: req_8f2c…
            details:
              type: object
              additionalProperties: true
    Location:
      type: object
      properties:
        id:
          type: string
          example: loc_023d6847de544fdb9a5510db
        object:
          type: string
          enum:
            - location
        organization_id:
          type: string
          nullable: true
        name:
          type: string
          example: Pokawa Châtelet
        currency:
          type: string
          example: EUR
        country:
          type: string
          example: FR
        timezone:
          type: string
          example: Europe/Paris
        default_language:
          type: string
          example: fr
        address:
          $ref: '#/components/schemas/Address'
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    Address:
      type: object
      nullable: true
      properties:
        line1:
          type: string
          nullable: true
        line2:
          type: string
          nullable: true
        postal_code:
          type: string
          nullable: true
        city:
          type: string
          nullable: true
        country:
          type: string
          nullable: true
        latitude:
          type: number
          nullable: true
        longitude:
          type: number
          nullable: true
  securitySchemes:
    organization-api-key:
      type: apiKey
      in: header
      name: x-api-key
      description: Location/organization API key.

````