# List Locations

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /locations:
    get:
      summary: List Locations
      deprecated: false
      description: ''
      operationId: GetLocationList
      tags:
        - API Reference/Locations
        - Locations
      parameters:
        - name: per_page
          in: query
          description: ''
          required: false
          example: 0
          schema:
            type: number
        - name: page
          in: query
          description: ''
          required: false
          example: 0
          schema:
            type: number
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  meta:
                    type: object
                    description: Additional response metadata (may be empty).
                    properties: {}
                    x-apidog-orders: []
                    x-apidog-ignore-properties: []
                  data:
                    type: array
                    items: &ref_1
                      $ref: '#/components/schemas/Location'
                    uniqueItems: true
                required:
                  - meta
                  - data
                x-apidog-orders:
                  - meta
                  - data
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: Success
      security: []
      x-apidog-folder: API Reference/Locations
      x-apidog-status: developing
      x-run-in-apidog: https://app.apidog.com/web/project/1200447/apis/api-28097127-run
components:
  schemas:
    Location:
      type: object
      description: >-
        Relationship container linking an organization and an optional parent
        reference.
      properties:
        id:
          type: string
          title: ''
          description: Unique identifier in the Makini dataset.
          readOnly: true
          examples:
            - 12345678aaaaaa111111bbbbbb222222cccccc33
        code:
          type: string
          title: ''
          description: A unique identifier code for this entity.
          examples:
            - entity-code-1
        _source:
          type: string
          title: ''
          description: >-
            The originating source table/endpoint or derivation name for this
            record.
          readOnly: true
          examples:
            - EndpointName
            - TableName
            - derived
        _idValue:
          type: string
          title: ''
          description: The original identifier value from the source system.
          readOnly: true
          examples:
            - '1234'
            - '000000001'
            - ABCID123
        _displayValue:
          type: string
          description: A human-readable display label derived from the source record.
          readOnly: true
          title: ''
        _updatedAt:
          type: string
          description: >-
            Timestamp indicating when this record was last updated in the source
            system.
          readOnly: true
          format: date-time
        _createdAt:
          type: string
          description: >-
            Timestamp indicating when this record was created in the source
            system.
          format: date-time
          readOnly: true
        _deletedAt:
          type: string
          description: >-
            Timestamp indicating when this record was deleted/soft-deleted in
            the source system; null if not deleted.
          format: date-time
          readOnly: true
          nullable: true
        _implements:
          type: array
          description: A list of interface/schema identifiers that this record implements.
          items:
            type: string
          readOnly: true
        name:
          type: string
          description: The name of the entity.
          examples:
            - Entity Name
        description:
          type: string
          description: An optional description providing more details about the entity.
          examples:
            - Entity Description
          nullable: true
        organization:
          description: >-
            The organization associated with this record. May be one of the
            referenced organization schemas or null.
          anyOf:
            - &ref_0
              $ref: '#/components/schemas/Relation'
            - &ref_2
              $ref: '#/components/schemas/Organization'
            - type: 'null'
        parent:
          description: >-
            The parent entity for this record. May be one of the referenced
            parent schemas or null when no parent exists.
          anyOf:
            - *ref_0
            - *ref_1
            - type: 'null'
      required:
        - id
        - code
        - _source
        - _idValue
        - _displayValue
        - _updatedAt
        - _createdAt
        - _deletedAt
        - _implements
        - name
      x-apidog-orders:
        - id
        - code
        - _source
        - _idValue
        - _displayValue
        - _updatedAt
        - _createdAt
        - _deletedAt
        - _implements
        - name
        - description
        - organization
        - parent
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
    Organization:
      type: object
      properties:
        id:
          type: string
          title: ''
          description: Unique identifier in the Makini dataset.
          readOnly: true
          examples:
            - 12345678aaaaaa111111bbbbbb222222cccccc33
        code:
          type: string
          title: ''
          description: A unique identifier code for this entity.
          examples:
            - entity-code-1
        _source:
          type: string
          title: ''
          description: >-
            The originating source table/endpoint or derivation name for this
            record.
          readOnly: true
          examples:
            - EndpointName
            - TableName
            - derived
        _idValue:
          type: string
          title: ''
          description: The original identifier value from the source system.
          readOnly: true
          examples:
            - '1234'
            - '000000001'
            - ABCID123
        _displayValue:
          type: string
          description: A human-readable display label derived from the source record.
          readOnly: true
          title: ''
        _updatedAt:
          type: string
          description: >-
            Timestamp indicating when this record was last updated in the source
            system.
          readOnly: true
          format: date-time
        _createdAt:
          type: string
          description: >-
            Timestamp indicating when this record was created in the source
            system.
          format: date-time
          readOnly: true
        _deletedAt:
          type: string
          description: >-
            Timestamp indicating when this record was deleted/soft-deleted in
            the source system; null if not deleted.
          format: date-time
          readOnly: true
          nullable: true
        _implements:
          type: array
          description: A list of interface/schema identifiers that this record implements.
          items:
            type: string
          readOnly: true
        name:
          type: string
          description: The name of the entity.
          examples:
            - Entity Name
        description:
          type: string
          description: An optional description providing more details about the entity.
          examples:
            - Entity Description
          nullable: true
        parent:
          oneOf:
            - *ref_0
            - *ref_2
        currency:
          oneOf:
            - *ref_0
            - &ref_3
              $ref: '#/components/schemas/Currency'
        language:
          oneOf:
            - *ref_0
            - &ref_4
              $ref: '#/components/schemas/Language'
      required:
        - id
        - code
        - _source
        - _idValue
        - _displayValue
        - _updatedAt
        - _createdAt
        - _deletedAt
        - _implements
        - name
      x-apidog-orders:
        - id
        - code
        - _source
        - _idValue
        - _displayValue
        - _updatedAt
        - _createdAt
        - _deletedAt
        - _implements
        - name
        - description
        - parent
        - currency
        - language
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
    Language:
      type: object
      properties:
        id:
          type: string
          title: ''
          description: Unique identifier in the Makini dataset.
          readOnly: true
          examples:
            - 12345678aaaaaa111111bbbbbb222222cccccc33
        code:
          type: string
          title: ''
          description: A unique identifier code for this entity.
          examples:
            - entity-code-1
        _source:
          type: string
          title: ''
          description: >-
            The originating source table/endpoint or derivation name for this
            record.
          readOnly: true
          examples:
            - EndpointName
            - TableName
            - derived
        _idValue:
          type: string
          title: ''
          description: The original identifier value from the source system.
          readOnly: true
          examples:
            - '1234'
            - '000000001'
            - ABCID123
        _displayValue:
          type: string
          description: A human-readable display label derived from the source record.
          readOnly: true
          title: ''
        _updatedAt:
          type: string
          description: >-
            Timestamp indicating when this record was last updated in the source
            system.
          readOnly: true
          format: date-time
        _createdAt:
          type: string
          description: >-
            Timestamp indicating when this record was created in the source
            system.
          format: date-time
          readOnly: true
        _deletedAt:
          type: string
          description: >-
            Timestamp indicating when this record was deleted/soft-deleted in
            the source system; null if not deleted.
          format: date-time
          readOnly: true
          nullable: true
        _implements:
          type: array
          description: A list of interface/schema identifiers that this record implements.
          items:
            type: string
          readOnly: true
        name:
          type: string
          description: The name of the entity.
          examples:
            - Entity Name
        description:
          type: string
          description: An optional description providing more details about the entity.
          examples:
            - Entity Description
          nullable: true
        nativeName:
          type: string
          nullable: true
        alpha2:
          type: string
          description: ISO 639-1 two-letter code
          minLength: 2
          maxLength: 2
          pattern: ^[a-z]{2}$
          examples:
            - en
            - de
            - es
            - ru
          nullable: true
        alpha3:
          type: string
          description: ISO 639-2/T three-letter code
          minLength: 3
          maxLength: 3
          pattern: ^[a-z]{3}$
          examples:
            - eng
            - deu
            - spa
            - rus
          nullable: true
        locale:
          type: string
          description: IETF BCP 47 code
          pattern: >-
            ^[a-z]{2,3}-(?:[A-Z][a-z]{3}(?:-(?:[A-Z]{2}|[0-9]{3}))?|(?:[A-Z]{2}|[0-9]{3}))$
          minLength: 5
          maxLength: 12
          examples:
            - en-US
            - en-GB
            - ru-RU
            - zh-Hans-CN
            - es-419
          nullable: true
        family:
          type: string
          nullable: true
        branch:
          type: string
          nullable: true
        scriptType:
          type: string
          nullable: true
        isRtl:
          type: boolean
          nullable: true
        isActive:
          type: boolean
          nullable: true
        countries:
          type: array
          items:
            anyOf:
              - *ref_0
              - &ref_6
                $ref: '#/components/schemas/Country'
      required:
        - id
        - code
        - _source
        - _idValue
        - _displayValue
        - _updatedAt
        - _createdAt
        - _deletedAt
        - _implements
        - name
      x-apidog-orders:
        - id
        - code
        - _source
        - _idValue
        - _displayValue
        - _updatedAt
        - _createdAt
        - _deletedAt
        - _implements
        - name
        - description
        - nativeName
        - alpha2
        - alpha3
        - locale
        - family
        - branch
        - scriptType
        - isRtl
        - isActive
        - countries
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
    Country:
      type: object
      properties:
        id:
          type: string
          title: ''
          description: Unique identifier in the Makini dataset.
          readOnly: true
          examples:
            - 12345678aaaaaa111111bbbbbb222222cccccc33
        code:
          type: string
          title: ''
          description: A unique identifier code for this entity.
          examples:
            - entity-code-1
        _source:
          type: string
          title: ''
          description: >-
            The originating source table/endpoint or derivation name for this
            record.
          readOnly: true
          examples:
            - EndpointName
            - TableName
            - derived
        _idValue:
          type: string
          title: ''
          description: The original identifier value from the source system.
          readOnly: true
          examples:
            - '1234'
            - '000000001'
            - ABCID123
        _displayValue:
          type: string
          description: A human-readable display label derived from the source record.
          readOnly: true
          title: ''
        _updatedAt:
          type: string
          description: >-
            Timestamp indicating when this record was last updated in the source
            system.
          readOnly: true
          format: date-time
        _createdAt:
          type: string
          description: >-
            Timestamp indicating when this record was created in the source
            system.
          format: date-time
          readOnly: true
        _deletedAt:
          type: string
          description: >-
            Timestamp indicating when this record was deleted/soft-deleted in
            the source system; null if not deleted.
          format: date-time
          readOnly: true
          nullable: true
        _implements:
          type: array
          description: A list of interface/schema identifiers that this record implements.
          items:
            type: string
          readOnly: true
        name:
          type: string
          description: The name of the entity.
          examples:
            - Entity Name
        description:
          type: string
          description: An optional description providing more details about the entity.
          examples:
            - Entity Description
          nullable: true
        officialName:
          type: string
          description: Official or formal name of the country
          examples:
            - United States of America
            - Federal Republic of Germany
            - United Kingdom of Great Britain and Northern Ireland
        alpha2:
          type: string
          description: ISO 3166-1 alpha-2 country code
          minLength: 2
          maxLength: 2
          pattern: ^[A-Z]{2}$
          examples:
            - US
            - GB
            - DE
            - RU
          nullable: true
        alpha3:
          type: string
          description: ISO 3166-1 alpha-3 country code
          pattern: ^[A-Z]{3}$
          minLength: 3
          maxLength: 3
          examples:
            - USA
            - GBR
            - DEU
            - RUS
          nullable: true
        isoNumeric:
          type: string
          description: ISO 3166-1 numeric country code
          minLength: 3
          maxLength: 3
          pattern: ^[0-9]{3}$
          examples:
            - '840'
            - '276'
            - '826'
            - '643'
          nullable: true
        region:
          type: string
          description: Geographic region (e.g., Americas, Europe, Asia)
          nullable: true
        subregion:
          type: string
          description: Geographic subregion (e.g., Northern America, Western Europe)
          nullable: true
        dialCode:
          type: string
          description: International dialing code
          nullable: true
        isActive:
          type: boolean
          description: Flag indicating if the country is available in the system
          nullable: true
        capital:
          anyOf:
            - *ref_0
            - &ref_5
              $ref: '#/components/schemas/Locality'
            - type: 'null'
        currency:
          anyOf:
            - *ref_0
            - *ref_3
            - type: 'null'
          description: Primary currency of the country
        languages:
          type: array
          items:
            anyOf:
              - *ref_0
              - *ref_4
      required:
        - id
        - code
        - _source
        - _idValue
        - _displayValue
        - _updatedAt
        - _createdAt
        - _deletedAt
        - _implements
        - name
        - officialName
      x-apidog-orders:
        - id
        - code
        - _source
        - _idValue
        - _displayValue
        - _updatedAt
        - _createdAt
        - _deletedAt
        - _implements
        - name
        - description
        - officialName
        - alpha2
        - alpha3
        - isoNumeric
        - region
        - subregion
        - dialCode
        - isActive
        - capital
        - currency
        - languages
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
    Locality:
      type: object
      properties:
        id:
          type: string
          title: ''
          description: Unique identifier in the Makini dataset.
          readOnly: true
          examples:
            - 12345678aaaaaa111111bbbbbb222222cccccc33
        code:
          type: string
          title: ''
          description: A unique identifier code for this entity.
          examples:
            - entity-code-1
        _source:
          type: string
          title: ''
          description: >-
            The originating source table/endpoint or derivation name for this
            record.
          readOnly: true
          examples:
            - EndpointName
            - TableName
            - derived
        _idValue:
          type: string
          title: ''
          description: The original identifier value from the source system.
          readOnly: true
          examples:
            - '1234'
            - '000000001'
            - ABCID123
        _displayValue:
          type: string
          description: A human-readable display label derived from the source record.
          readOnly: true
          title: ''
        _updatedAt:
          type: string
          description: >-
            Timestamp indicating when this record was last updated in the source
            system.
          readOnly: true
          format: date-time
        _createdAt:
          type: string
          description: >-
            Timestamp indicating when this record was created in the source
            system.
          format: date-time
          readOnly: true
        _deletedAt:
          type: string
          description: >-
            Timestamp indicating when this record was deleted/soft-deleted in
            the source system; null if not deleted.
          format: date-time
          readOnly: true
          nullable: true
        _implements:
          type: array
          description: A list of interface/schema identifiers that this record implements.
          items:
            type: string
          readOnly: true
        name:
          type: string
          description: The name of the entity.
          examples:
            - Entity Name
        description:
          type: string
          description: An optional description providing more details about the entity.
          examples:
            - Entity Description
          nullable: true
        isoCode:
          type: string
        postalCodes:
          type: array
          items:
            type: string
        timezone:
          type: string
          examples:
            - America/Los_Angeles
        isActive:
          type: boolean
        parent:
          oneOf:
            - *ref_0
            - *ref_5
            - type: 'null'
        country:
          oneOf:
            - *ref_0
            - *ref_6
            - type: 'null'
      required:
        - id
        - code
        - _source
        - _idValue
        - _displayValue
        - _updatedAt
        - _createdAt
        - _deletedAt
        - _implements
        - name
      x-apidog-orders:
        - id
        - code
        - _source
        - _idValue
        - _displayValue
        - _updatedAt
        - _createdAt
        - _deletedAt
        - _implements
        - name
        - description
        - isoCode
        - postalCodes
        - timezone
        - isActive
        - parent
        - country
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
    Currency:
      type: object
      properties:
        id:
          type: string
          title: ''
          description: Unique identifier in the Makini dataset.
          readOnly: true
          examples:
            - 12345678aaaaaa111111bbbbbb222222cccccc33
        code:
          type: string
          title: ''
          description: A unique identifier code for this entity.
          examples:
            - entity-code-1
        _source:
          type: string
          title: ''
          description: >-
            The originating source table/endpoint or derivation name for this
            record.
          readOnly: true
          examples:
            - EndpointName
            - TableName
            - derived
        _idValue:
          type: string
          title: ''
          description: The original identifier value from the source system.
          readOnly: true
          examples:
            - '1234'
            - '000000001'
            - ABCID123
        _displayValue:
          type: string
          description: A human-readable display label derived from the source record.
          readOnly: true
          title: ''
        _updatedAt:
          type: string
          description: >-
            Timestamp indicating when this record was last updated in the source
            system.
          readOnly: true
          format: date-time
        _createdAt:
          type: string
          description: >-
            Timestamp indicating when this record was created in the source
            system.
          format: date-time
          readOnly: true
        _deletedAt:
          type: string
          description: >-
            Timestamp indicating when this record was deleted/soft-deleted in
            the source system; null if not deleted.
          format: date-time
          readOnly: true
          nullable: true
        _implements:
          type: array
          description: A list of interface/schema identifiers that this record implements.
          items:
            type: string
          readOnly: true
        name:
          type: string
          description: The name of the entity.
          examples:
            - Entity Name
        description:
          type: string
          description: An optional description providing more details about the entity.
          examples:
            - Entity Description
          nullable: true
        symbol:
          type: string
        decimalPlaces:
          type: integer
          default: 2
        isActive:
          type: boolean
      required:
        - id
        - code
        - _source
        - _idValue
        - _displayValue
        - _updatedAt
        - _createdAt
        - _deletedAt
        - _implements
        - name
        - isActive
      x-apidog-orders:
        - id
        - code
        - _source
        - _idValue
        - _displayValue
        - _updatedAt
        - _createdAt
        - _deletedAt
        - _implements
        - name
        - description
        - symbol
        - decimalPlaces
        - isActive
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
    Relation:
      type: object
      properties:
        id:
          type: string
          description: Related entity Makini ID
          examples:
            - 12345678aaaaaa111111bbbbbb222222cccccc33
        _idValue:
          type: string
          examples:
            - '1234'
            - '000000001'
            - ABCID123
          description: Related entity source ID
        _displayValue:
          type: string
          description: Human-readable description
        rel:
          type: string
          readOnly: true
          examples:
            - endpoint
          description: Related endpoint
        href:
          type: string
          format: uri
          readOnly: true
          examples:
            - >-
              https://api.makini.io/v4/endpoints/12345678aaaaaa111111bbbbbb222222cccccc33
          description: Resource URI
      required:
        - id
        - _idValue
        - _displayValue
        - rel
        - href
      x-apidog-orders:
        - id
        - _idValue
        - _displayValue
        - rel
        - href
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
  securitySchemes:
    Connection Token:
      type: bearer
      scheme: bearer
    Account Credentials:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://
servers:
  - url: https://api.makini.io/v4
    description: Prod Env
security: []

```