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

# List Locations



## OpenAPI

````yaml get /v1/locations
openapi: 3.1.0
info:
  version: 1.0.0
  title: every public api
servers:
  - url: https://api.goevery.co
security:
  - bearerAuth: []
paths:
  /v1/locations:
    get:
      parameters:
        - schema:
            type:
              - number
              - 'null'
            exclusiveMinimum: 0
            maximum: 1000
            example: 100
          required: false
          name: pageSize
          in: query
          description: >-
            The maximum number of locations to return. Defaults to 100 if not
            specified. Must be a positive number and not exceed 1000.
        - schema:
            type:
              - string
              - 'null'
          required: false
          name: pageToken
          in: query
          description: A token to retrieve the next page of results. Used for pagination.
        - schema:
            type:
              - string
              - 'null'
          required: false
          name: query
          in: query
          description: >-
            A query string to filter the locations. The query can be a substring
            of the location name or address.
      responses:
        '200':
          description: Successfully retrieved list of locations.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListLocationsResponse'
components:
  schemas:
    ListLocationsResponse:
      type: object
      properties:
        locations:
          type: array
          items:
            $ref: '#/components/schemas/Location'
          description: An array of locations.
        nextPageToken:
          type:
            - string
            - 'null'
          description: A token to retrieve the next page of results, if any.
      required:
        - locations
    Location:
      type: object
      properties:
        name:
          type: string
          description: The resource name for the location.
          example: locations/CO-54003000
        address:
          type: object
          properties:
            regionCode:
              type: string
              description: The ISO 3166-1 alpha-2 region code of the location.
              example: CO
            administrativeArea:
              type: string
              description: The administrative area (state, province, etc.) of the location.
              example: Antioquia
            locality:
              type: string
              description: The locality (city, town, etc.) of the location.
              example: Abejorral
          required:
            - regionCode
            - administrativeArea
            - locality
          description: The address details of the location.
      required:
        - name
        - address
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````