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

# List countries

> Reference catalogue of supported countries.



## OpenAPI

````yaml GET /generals/countries/
openapi: 3.0.3
info:
  title: Piriod API
  version: 1.0.0
  description: >
    Piriod API for billing, payments, procurement and collections.


    All requests require:

    - `Authorization: Token <api_token>` header.

    - `x-simple-workspace: <workspace_id>` header (the account/workspace
    identifier).

    - Optionally `x-piriod-test-mode: true` to operate against test-mode data.


    See the Documentation tab for getting started, integration flows,
    authentication,

    error handling and pagination/filtering guides.
servers:
  - url: https://api.piriod.com
    description: Production
security:
  - TokenAuth: []
paths:
  /generals/countries/:
    get:
      tags:
        - Collections
      summary: List countries
      description: Reference catalogue of supported countries.
      parameters:
        - $ref: '#/components/parameters/PageQuery'
        - $ref: '#/components/parameters/PageSizeQuery'
      responses:
        '200':
          description: Paginated country list.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/Paginated'
                  - type: object
                    properties:
                      results:
                        type: array
                        items:
                          $ref: '#/components/schemas/GeneralCountry'
components:
  parameters:
    PageQuery:
      name: page
      in: query
      required: false
      schema:
        type: integer
        minimum: 1
        default: 1
      description: Page number to retrieve (1-indexed).
    PageSizeQuery:
      name: page_size
      in: query
      required: false
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 20
      description: Number of items per page.
  schemas:
    Paginated:
      type: object
      required:
        - count
        - results
      properties:
        count:
          type: integer
          description: Total number of items matching the filter.
          example: 142
        next:
          type: string
          format: uri
          nullable: true
          description: URL of the next page, or `null` if last page.
        previous:
          type: string
          format: uri
          nullable: true
          description: URL of the previous page, or `null` if first page.
        results:
          type: array
          items: {}
          description: The items in the current page.
    GeneralCountry:
      type: object
      properties:
        id:
          type: string
          example: CL
          description: ISO-3166-1 alpha-2 code.
        name:
          type: string
        name_default:
          type: string
        phone_code:
          type: string
          example: '+56'
        three_code:
          type: string
          nullable: true
          example: CHL
        has_regulation:
          type: boolean
        tax_percent:
          type: number
        locale:
          type: string
          nullable: true
  securitySchemes:
    TokenAuth:
      type: apiKey
      in: header
      name: Authorization
      description: |
        Use header `Authorization: Token <api_token>`.
        API tokens are obtained from the Piriod dashboard.

````