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

# Get Countries

> Returns all available countries a contact or person could belong to.

NsApiSlow threshold: 5000 ms.



## OpenAPI

````yaml /openapi/agent/openapi-v3-ListAgent.json post /api/v1/Agents/List/GetCountries
openapi: 3.0.0
info:
  version: v1-Agents
  title: SuperOffice Agent API v1
  description: SuperOffice Agent API - ListAgent
  contact:
    name: SuperOffice DevNet
    url: https://docs.superoffice.com/en/api/index.html
    email: sdk@superoffice.com
servers:
  - url: http://localhost:56350
  - url: https://localhost:56350
security: []
tags: []
externalDocs:
  description: >-
    The SuperOffice DevNet Community has more documentation, examples, and
    discussion forums.
  url: https://community.superoffice.com/en/developer/
paths:
  /api/v1/Agents/List/GetCountries:
    post:
      tags:
        - List_Agent
      summary: Get Countries
      description: |-
        Returns all available countries a contact or person could belong to.

        NsApiSlow threshold: 5000 ms.
      operationId: v1ListAgent_GetCountries
      parameters:
        - name: $select
          in: query
          description: >-
            Optional comma separated list of properties to include in the
            result. Other fields are then nulled out to reduce payload size:
            "Name,department,category". Default = show all fields.
          required: false
          schema:
            type: string
        - name: Accept-Language
          in: header
          description: >-
            Convert string references and multi-language values into a specified
            language (iso2) code.
          required: false
          schema:
            type: string
        - name: SO-Language
          in: header
          description: >-
            Convert string references and multi-language values into a specified
            language (iso2) code. Overrides Accept-Language value.
          required: false
          schema:
            type: string
        - name: SO-Culture
          in: header
          description: >-
            Number, date formatting in a specified culture (iso2 language) code.
            Partially overrides SO-Language/Accept-Language value. Ignored if no
            Language set.
          required: false
          schema:
            type: string
        - name: SO-TimeZone
          in: header
          description: >-
            Specify the timezone code that you would like date/time responses
            converted to.
          required: false
          schema:
            type: string
        - name: SO-AppToken
          in: header
          description: >-
            The application token that identifies the partner app. Used when
            calling Online WebAPI from a server.
          required: false
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SuperOffice.CRM.Services.Country'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SuperOffice.CRM.Services.Country'
            application/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SuperOffice.CRM.Services.Country'
            text/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SuperOffice.CRM.Services.Country'
            application/json-patch+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SuperOffice.CRM.Services.Country'
            application/merge-patch+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SuperOffice.CRM.Services.Country'
      security:
        - SuperOffice_Password: []
          SuperId_Authentication: []
components:
  schemas:
    SuperOffice.CRM.Services.Country:
      description: "Carrier object for Country.\r\nServices for the Country Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IListAgent\">List Agent</see>."
      type: object
      properties:
        CountryId:
          format: int32
          description: Primary key
          type: integer
        Name:
          description: Name of country in installed language
          type: string
        CurrencyId:
          format: int32
          description: Default currency for this country
          type: integer
        EnglishName:
          description: Name of country in english
          type: string
        TwoLetterISOCountry:
          description: Two-letter country-code according to ISO3166
          type: string
        ThreeLetterISOCountry:
          description: Three-letter country-code according to ISO3166
          type: string
        ImageDescription:
          description: >-
            Description of the country's flag image. (This is the country flag
            that is displayed in the CRM client)
          type: string
        OrgNrText:
          description: Lead text for organisation field
          type: string
        InterAreaPrefix:
          description: International prefix
          type: string
        DialInPrefix:
          description: Dial in prefix
          type: string
        ZipPrefix:
          description: Post prefix
          type: string
        DomainName:
          description: Domain name of the country
          type: string
        AddressLayoutId:
          format: int32
          description: Address layout of the country
          type: integer
        DomesticAddressLayoutId:
          format: int32
          description: Domestic address layout of the country
          type: integer
        ForeignAddressLayoutId:
          format: int32
          description: Foreign address layout of the country
          type: integer
        Rank:
          format: int32
          description: The rank of the country
          type: integer
        Tooltip:
          description: The tooltip of the country
          type: string
        Deleted:
          description: true if the country is deleted
          type: boolean
        TableRight:
          $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight'
        FieldProperties:
          description: >-
            Field property dictionary mapping field names to field access
            rights.
          type: object
          additionalProperties:
            $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty'
    SuperOffice.CRM.Security.TableRight:
      description: "Wraps a table right together with an explanatory reason.\r\nCode can indicate why access is restricted."
      type: object
      properties:
        Mask:
          type: string
        Reason:
          type: string
    SuperOffice.CRM.Security.FieldProperty:
      description: >-
        Class holding properties like field length, field type about a field in
        the carrier.
      type: object
      properties:
        FieldRight:
          $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldRight'
        FieldType:
          type: string
        FieldLength:
          format: int32
          description: ''
          type: integer
    SuperOffice.CRM.Security.FieldRight:
      description: "Wraps the field right together with an explanatory reason.\r\nAlso adds logical operators to the field rights so that they can be easily combined."
      type: object
      properties:
        Mask:
          type: string
        Reason:
          type: string

````

## Related topics

- [Get Country](/en/api/reference/restful/rest/list_country/get-country.md)
- [Get Country Headings](/en/api/reference/restful/rest/list_country/get-country-headings.md)
- [Get Country List](/en/api/reference/restful/agent/list_agent/get-country-list.md)
- [Get Country Headings For List Item](/en/api/reference/restful/rest/list_country/get-country-headings-for-list-item.md)
- [Get Country User Groups For List Item](/en/api/reference/restful/rest/list_country/get-country-user-groups-for-list-item.md)
