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

# Get employee country fields

> Retrieve the Portuguese employee fields (academic qualification, professional situation, retirement regime, beneficiary name). Returns `data: null` when the company is not located in Portugal.

<div className="endpoint-versions" data-nav-page="/api-reference-v2/core/v4/employees-employee-id-country-fields-get" data-nav-group="Employees">
  <span className="endpoint-versions-label">Version:</span>
  <span data-version="v4" data-current>v4</span>
</div>


## OpenAPI

````yaml openapi-v2.json GET /core/v4/employees/{employeeId}/country-fields
openapi: 3.0.0
info:
  title: Sesame Public API v2
  description: >-
    Public API v2 — additive surface `/public/{context}/v{N}`,
    endpoint-versioned from v4
  version: 1.0.0
servers:
  - url: https://api.sesamehr.com
    description: Production
security:
  - Bearer: []
paths:
  /core/v4/employees/{employeeId}/country-fields:
    get:
      tags:
        - Employees
      summary: Get employee country fields
      description: >-
        Retrieve the Portuguese employee fields (academic qualification,
        professional situation, retirement regime, beneficiary name). Returns
        `data: null` when the company is not located in Portugal.
      operationId: GetEmployeeCountryFields
      parameters:
        - name: employeeId
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: The employee country fields.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmployeeCountryFieldsResponse'
        '401':
          description: Missing or invalid API key
        '403':
          description: API consumer lacks permission over the requested resource
        '422':
          description: Validation error
components:
  schemas:
    EmployeeCountryFieldsResponse:
      properties:
        data:
          description: >-
            Portuguese employee fields; null when the company is not located in
            Portugal.
          nullable: true
          allOf:
            - $ref: '#/components/schemas/EmployeeCountryFieldsEntry'
      type: object
    EmployeeCountryFieldsEntry:
      properties:
        country:
          description: Company country (ISO alpha-2). Only Portugal is supported.
          type: string
          example: PT
        fields:
          description: >-
            Portuguese employee fields. A field without a stored value is
            returned with its default value.
          properties:
            beneficiaryName:
              type: string
              example: null
              nullable: true
            academicQualification:
              type: string
              example: 1º Ciclo do Ensino Básico
              nullable: true
            professionalSituation:
              type: string
              example: 2 - Trabalhador Familiar não Remunerado
              nullable: true
            retirementRegime:
              type: string
              example: 2 - Caixa Geral de Aposentações
              nullable: true
          type: object
      type: object
  securitySchemes:
    Bearer:
      type: http
      description: 'Sesame Public API consumer token (Authorization: Bearer <token>)'
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.