1 of 36

AG5 API

API reference

Achievements

ContractTypes

EmploymentContracts

EmploymentRelations

Employments

Achievements

ApprovedAchievements

InProgressEntries

Positions

ReferringRelations

SubmittedAchievements

EmploymentUnavailabilities

EvidenceVariants

Achievements

InProgressEntries

Groupings

DefinedGroupings

GroupingTypes

Instances

InProgressEntries

MeasurementSystems

Qualifications

MeasurementValues

Positions

Qualifications

Achievements

EvidenceVariants

InProgressEntries

QualificationTypes

Qualifications

ServiceIsAvailable

ServiceVersion

AG5 API Description

Welcome to the AG5 API Frequently Asked Questions (FAQ) page. Here, you’ll find answers to common inquiries regarding our API capabilities, data updates and integration requirements.

Does AG5 support custom reports for API integration?

Yes, AG5 can support custom reports; however, this is not a standard use case. If you require a custom reporting solution, please contact our team to discuss specific requirements and feasibility.

How frequently does the AG5 API update?

The AG5 API updates every hour, ensuring that data remains current and synchronized.

What is required on the customer's side to connect to the AG5 API?

Customers must set up an ETL (Extract, Transform, Load) pipeline within their own infrastructure. This typically requires involvement from their Data/IT department to:

Extract data from the AG5 API
Store it in their data warehouse
Connect the warehouse to Power BI or another BI tool for visualization and analysis

For more details on API integration, please refer to our technical documentation.

AG5 API Glossary

This Glossary provides definitions for key terms used in the AG5 API. This section helps users understand important concepts, data structures and terminology relevant to AG5 API integration.

Achievements

Achievements represent completed qualifications or certifications assigned to a user. They contain key details such as issue date, expiration date, associated documents, and approval status. Achievements can be retrieved via the API to track progress, validate qualifications, or integrate with external reporting systems.

Contract Types

Contract types define different categories of employment or service agreements within the system. Each contract type includes a unique identifier, name, external code and timestamps for creation and last modification.

GET /contractTypes – Retrieves a list of all contract types available to the API user. Supports pagination using deltaToken and pageToken.
GET /contractTypes/{id} – Fetches details of a specific contract type by its unique id.

These endpoints allow organizations to standardize and manage contract classifications within their HR or workforce management systems.

List all achievements viewable for API user

get

/achievements

Authorizations

Query parameters

pageTokenstring

limitinteger · int32

sinceDeltaTokenstring

fieldsstring[]

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/achievements' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

{
  "results": [
    {
      "remark": "text",
      "lastModifiedAt": "text",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "issueDate": "2025-03-12",
      "overriddenExpirationDate": "2025-03-12",
      "qualificationID": "550e8400-e29b-41d4-a716-446655440000",
      "evidenceVariantID": "550e8400-e29b-41d4-a716-446655440000",
      "externalId": "text",
      "documents": [
        {
          "contentType": "text",
          "filename": "text"
        }
      ],
      "externalCode": "text",
      "scoreOrder": 1,
      "submittedByID": "550e8400-e29b-41d4-a716-446655440000",
      "approvedByID": "550e8400-e29b-41d4-a716-446655440000",
      "isAutoAchieved": true,
      "createdAt": "text",
      "employmentID": "550e8400-e29b-41d4-a716-446655440000",
      "expirationDate": "2025-03-12"
    }
  ],
  "deltaToken": "text",
  "pageToken": "text"
}

Successful request

get

/achievements/{id}

Authorizations

Path parameters

idstring · hexadecimal-integerrequired

Example: 550e8400-e29b-41d4-a716-446655440000

Pattern: ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/achievements/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

{
  "remark": "text",
  "lastModifiedAt": "text",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "issueDate": "2025-03-12",
  "overriddenExpirationDate": "2025-03-12",
  "qualificationID": "550e8400-e29b-41d4-a716-446655440000",
  "evidenceVariantID": "550e8400-e29b-41d4-a716-446655440000",
  "externalId": "text",
  "documents": [
    {
      "contentType": "text",
      "filename": "text"
    }
  ],
  "externalCode": "text",
  "scoreOrder": 1,
  "submittedByID": "550e8400-e29b-41d4-a716-446655440000",
  "approvedByID": "550e8400-e29b-41d4-a716-446655440000",
  "isAutoAchieved": true,
  "createdAt": "text",
  "employmentID": "550e8400-e29b-41d4-a716-446655440000",
  "expirationDate": "2025-03-12"
}

Successful request

get

/employments/{id}/achievements

Authorizations

Path parameters

idstring · hexadecimal-integerrequired

Example: 550e8400-e29b-41d4-a716-446655440000

Pattern: ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$

Query parameters

pageTokenstring

limitinteger · int32

fieldsstring[]

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/employments/{id}/achievements' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

{
  "results": [
    {
      "remark": "text",
      "lastModifiedAt": "text",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "issueDate": "2025-03-12",
      "overriddenExpirationDate": "2025-03-12",
      "qualificationID": "550e8400-e29b-41d4-a716-446655440000",
      "evidenceVariantID": "550e8400-e29b-41d4-a716-446655440000",
      "externalId": "text",
      "documents": [
        {
          "contentType": "text",
          "filename": "text"
        }
      ],
      "externalCode": "text",
      "scoreOrder": 1,
      "submittedByID": "550e8400-e29b-41d4-a716-446655440000",
      "approvedByID": "550e8400-e29b-41d4-a716-446655440000",
      "isAutoAchieved": true,
      "createdAt": "text",
      "employmentID": "550e8400-e29b-41d4-a716-446655440000",
      "expirationDate": "2025-03-12"
    }
  ],
  "deltaToken": "text",
  "pageToken": "text"
}

Successful request

get

/contractTypes/{id}

Authorizations

Path parameters

idstring · hexadecimal-integerrequired

Example: 550e8400-e29b-41d4-a716-446655440000

Pattern: ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/contractTypes/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

{
  "name": "text",
  "externalCode": "text",
  "lastModifiedAt": "text",
  "createdAt": "text",
  "externalId": "text",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "code": "text"
}

Successful request

get

/employmentContracts/{id}

Authorizations

Path parameters

idstring · hexadecimal-integerrequired

Example: 550e8400-e29b-41d4-a716-446655440000

Pattern: ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/employmentContracts/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "interval": {},
  "externalCode": "text",
  "createdAt": "text",
  "contractTypeID": "550e8400-e29b-41d4-a716-446655440000",
  "lastModifiedAt": "text",
  "externalId": "text",
  "employmentID": "550e8400-e29b-41d4-a716-446655440000"
}

Successful request

get

/employments/{id}/approvedAchievements

Authorizations

Path parameters

idstring · hexadecimal-integerrequired

Example: 550e8400-e29b-41d4-a716-446655440000

Pattern: ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$

Query parameters

pageTokenstring

limitinteger · int32

fieldsstring[]

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/employments/{id}/approvedAchievements' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

{
  "results": [
    {
      "remark": "text",
      "lastModifiedAt": "text",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "issueDate": "2025-03-12",
      "overriddenExpirationDate": "2025-03-12",
      "qualificationID": "550e8400-e29b-41d4-a716-446655440000",
      "evidenceVariantID": "550e8400-e29b-41d4-a716-446655440000",
      "externalId": "text",
      "documents": [
        {
          "contentType": "text",
          "filename": "text"
        }
      ],
      "externalCode": "text",
      "scoreOrder": 1,
      "submittedByID": "550e8400-e29b-41d4-a716-446655440000",
      "approvedByID": "550e8400-e29b-41d4-a716-446655440000",
      "isAutoAchieved": true,
      "createdAt": "text",
      "employmentID": "550e8400-e29b-41d4-a716-446655440000",
      "expirationDate": "2025-03-12"
    }
  ],
  "deltaToken": "text",
  "pageToken": "text"
}

Successful request

List all employments viewable for API user

get

/employments

Authorizations

Query parameters

pageTokenstring

limitinteger · int32

sinceDeltaTokenstring

fieldsstring[]

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/employments' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

{
  "results": [
    {
      "externalCode": "text",
      "remark": "text",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "employeeNumber": "text",
      "externalId": "text",
      "firstName": "text",
      "customValues": {},
      "employmentContracts": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "interval": {},
          "externalCode": "text",
          "createdAt": "text",
          "contractTypeID": "550e8400-e29b-41d4-a716-446655440000",
          "lastModifiedAt": "text",
          "externalId": "text",
          "employmentID": "550e8400-e29b-41d4-a716-446655440000"
        }
      ],
      "email": "text",
      "createdAt": "text",
      "surname": "text",
      "initials": "text",
      "relations": [
        {
          "fromEmploymentID": "550e8400-e29b-41d4-a716-446655440000",
          "lastModifiedAt": "text",
          "createdAt": "text",
          "interval": {},
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "toEmploymentID": "550e8400-e29b-41d4-a716-446655440000"
        }
      ],
      "birthDate": "2025-03-12",
      "referringRelations": [
        {
          "fromEmploymentID": "550e8400-e29b-41d4-a716-446655440000",
          "lastModifiedAt": "text",
          "createdAt": "text",
          "interval": {},
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "toEmploymentID": "550e8400-e29b-41d4-a716-446655440000"
        }
      ],
      "employmentUnavailabilities": [
        {
          "reason": "text",
          "lastModifiedAt": "text",
          "createdAt": "text",
          "interval": {},
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "employmentID": "550e8400-e29b-41d4-a716-446655440000"
        }
      ],
      "positions": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "interval": {},
          "externalCode": "text",
          "createdAt": "text",
          "externalId": "text",
          "lastModifiedAt": "text",
          "employmentID": "550e8400-e29b-41d4-a716-446655440000",
          "tagIDs": [
            "550e8400-e29b-41d4-a716-446655440000"
          ]
        }
      ],
      "lastModifiedAt": "text"
    }
  ],
  "deltaToken": "text",
  "pageToken": "text"
}

Successful request

get

/employments/{id}

Authorizations

Path parameters

idstring · hexadecimal-integerrequired

Example: 550e8400-e29b-41d4-a716-446655440000

Pattern: ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/employments/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

{
  "externalCode": "text",
  "remark": "text",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "employeeNumber": "text",
  "externalId": "text",
  "firstName": "text",
  "customValues": {},
  "employmentContracts": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "interval": {},
      "externalCode": "text",
      "createdAt": "text",
      "contractTypeID": "550e8400-e29b-41d4-a716-446655440000",
      "lastModifiedAt": "text",
      "externalId": "text",
      "employmentID": "550e8400-e29b-41d4-a716-446655440000"
    }
  ],
  "email": "text",
  "createdAt": "text",
  "surname": "text",
  "initials": "text",
  "relations": [
    {
      "fromEmploymentID": "550e8400-e29b-41d4-a716-446655440000",
      "lastModifiedAt": "text",
      "createdAt": "text",
      "interval": {},
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "toEmploymentID": "550e8400-e29b-41d4-a716-446655440000"
    }
  ],
  "birthDate": "2025-03-12",
  "referringRelations": [
    {
      "fromEmploymentID": "550e8400-e29b-41d4-a716-446655440000",
      "lastModifiedAt": "text",
      "createdAt": "text",
      "interval": {},
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "toEmploymentID": "550e8400-e29b-41d4-a716-446655440000"
    }
  ],
  "employmentUnavailabilities": [
    {
      "reason": "text",
      "lastModifiedAt": "text",
      "createdAt": "text",
      "interval": {},
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "employmentID": "550e8400-e29b-41d4-a716-446655440000"
    }
  ],
  "positions": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "interval": {},
      "externalCode": "text",
      "createdAt": "text",
      "externalId": "text",
      "lastModifiedAt": "text",
      "employmentID": "550e8400-e29b-41d4-a716-446655440000",
      "tagIDs": [
        "550e8400-e29b-41d4-a716-446655440000"
      ]
    }
  ],
  "lastModifiedAt": "text"
}

Successful request

get

/contractTypes/{id}/employmentContracts

Authorizations

Path parameters

idstring · hexadecimal-integerrequired

Example: 550e8400-e29b-41d4-a716-446655440000

Pattern: ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$

Query parameters

pageTokenstring

limitinteger · int32

fieldsstring[]

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/contractTypes/{id}/employmentContracts' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

{
  "results": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "interval": {},
      "externalCode": "text",
      "createdAt": "text",
      "contractTypeID": "550e8400-e29b-41d4-a716-446655440000",
      "lastModifiedAt": "text",
      "externalId": "text",
      "employmentID": "550e8400-e29b-41d4-a716-446655440000"
    }
  ],
  "deltaToken": "text",
  "pageToken": "text"
}

Successful request

get

/employments/{id}/referringRelations

Authorizations

Path parameters

idstring · hexadecimal-integerrequired

Example: 550e8400-e29b-41d4-a716-446655440000

Pattern: ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$

Query parameters

pageTokenstring

limitinteger · int32

fieldsstring[]

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/employments/{id}/referringRelations' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

{
  "results": [
    {
      "fromEmploymentID": "550e8400-e29b-41d4-a716-446655440000",
      "lastModifiedAt": "text",
      "createdAt": "text",
      "interval": {},
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "toEmploymentID": "550e8400-e29b-41d4-a716-446655440000"
    }
  ],
  "deltaToken": "text",
  "pageToken": "text"
}

Successful request

get

/employments/{id}/positions

Authorizations

Path parameters

idstring · hexadecimal-integerrequired

Example: 550e8400-e29b-41d4-a716-446655440000

Pattern: ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$

Query parameters

pageTokenstring

limitinteger · int32

fieldsstring[]

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/employments/{id}/positions' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

{
  "results": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "interval": {},
      "externalCode": "text",
      "createdAt": "text",
      "externalId": "text",
      "lastModifiedAt": "text",
      "employmentID": "550e8400-e29b-41d4-a716-446655440000",
      "tagIDs": [
        "550e8400-e29b-41d4-a716-446655440000"
      ]
    }
  ],
  "deltaToken": "text",
  "pageToken": "text"
}

Successful request

get

/employmentRelations/{id}

Authorizations

Path parameters

idstring · hexadecimal-integerrequired

Example: 550e8400-e29b-41d4-a716-446655440000

Pattern: ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/employmentRelations/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

{
  "fromEmploymentID": "550e8400-e29b-41d4-a716-446655440000",
  "lastModifiedAt": "text",
  "createdAt": "text",
  "interval": {},
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "toEmploymentID": "550e8400-e29b-41d4-a716-446655440000"
}

Successful request

get

/evidenceVariants/{id}/inProgressEntries

Authorizations

Path parameters

idstring · hexadecimal-integerrequired

Example: 550e8400-e29b-41d4-a716-446655440000

Pattern: ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$

Query parameters

pageTokenstring

limitinteger · int32

fieldsstring[]

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/evidenceVariants/{id}/inProgressEntries' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

{
  "results": [
    {
      "remark": "text",
      "toDate": "2025-03-12",
      "lastModifiedAt": "text",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "plannedScoreOrder": 1,
      "closeDate": "2025-03-12",
      "qualificationID": "550e8400-e29b-41d4-a716-446655440000",
      "evidenceVariantID": "550e8400-e29b-41d4-a716-446655440000",
      "externalId": "text",
      "externalCode": "text",
      "fromDate": "2025-03-12",
      "createdAt": "text",
      "employmentID": "550e8400-e29b-41d4-a716-446655440000",
      "deadlineDate": "2025-03-12"
    }
  ],
  "deltaToken": "text",
  "pageToken": "text"
}

Successful request

get

/employments/{id}/inProgressEntries

Authorizations

Path parameters

idstring · hexadecimal-integerrequired

Example: 550e8400-e29b-41d4-a716-446655440000

Pattern: ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$

Query parameters

pageTokenstring

limitinteger · int32

fieldsstring[]

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/employments/{id}/inProgressEntries' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

{
  "results": [
    {
      "remark": "text",
      "toDate": "2025-03-12",
      "lastModifiedAt": "text",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "plannedScoreOrder": 1,
      "closeDate": "2025-03-12",
      "qualificationID": "550e8400-e29b-41d4-a716-446655440000",
      "evidenceVariantID": "550e8400-e29b-41d4-a716-446655440000",
      "externalId": "text",
      "externalCode": "text",
      "fromDate": "2025-03-12",
      "createdAt": "text",
      "employmentID": "550e8400-e29b-41d4-a716-446655440000",
      "deadlineDate": "2025-03-12"
    }
  ],
  "deltaToken": "text",
  "pageToken": "text"
}

Successful request

get

/evidenceVariants/{id}/achievements

Authorizations

Path parameters

idstring · hexadecimal-integerrequired

Example: 550e8400-e29b-41d4-a716-446655440000

Pattern: ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$

Query parameters

pageTokenstring

limitinteger · int32

fieldsstring[]

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/evidenceVariants/{id}/achievements' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

{
  "results": [
    {
      "remark": "text",
      "lastModifiedAt": "text",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "issueDate": "2025-03-12",
      "overriddenExpirationDate": "2025-03-12",
      "qualificationID": "550e8400-e29b-41d4-a716-446655440000",
      "evidenceVariantID": "550e8400-e29b-41d4-a716-446655440000",
      "externalId": "text",
      "documents": [
        {
          "contentType": "text",
          "filename": "text"
        }
      ],
      "externalCode": "text",
      "scoreOrder": 1,
      "submittedByID": "550e8400-e29b-41d4-a716-446655440000",
      "approvedByID": "550e8400-e29b-41d4-a716-446655440000",
      "isAutoAchieved": true,
      "createdAt": "text",
      "employmentID": "550e8400-e29b-41d4-a716-446655440000",
      "expirationDate": "2025-03-12"
    }
  ],
  "deltaToken": "text",
  "pageToken": "text"
}

Successful request

get

/employmentUnavailabilities/{id}

Authorizations

Path parameters

idstring · hexadecimal-integerrequired

Example: 550e8400-e29b-41d4-a716-446655440000

Pattern: ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/employmentUnavailabilities/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

{
  "reason": "text",
  "lastModifiedAt": "text",
  "createdAt": "text",
  "interval": {},
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "employmentID": "550e8400-e29b-41d4-a716-446655440000"
}

Successful request

get

/employments/{id}/submittedAchievements

Authorizations

Path parameters

idstring · hexadecimal-integerrequired

Example: 550e8400-e29b-41d4-a716-446655440000

Pattern: ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$

Query parameters

pageTokenstring

limitinteger · int32

fieldsstring[]

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/employments/{id}/submittedAchievements' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

{
  "results": [
    {
      "remark": "text",
      "lastModifiedAt": "text",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "issueDate": "2025-03-12",
      "overriddenExpirationDate": "2025-03-12",
      "qualificationID": "550e8400-e29b-41d4-a716-446655440000",
      "evidenceVariantID": "550e8400-e29b-41d4-a716-446655440000",
      "externalId": "text",
      "documents": [
        {
          "contentType": "text",
          "filename": "text"
        }
      ],
      "externalCode": "text",
      "scoreOrder": 1,
      "submittedByID": "550e8400-e29b-41d4-a716-446655440000",
      "approvedByID": "550e8400-e29b-41d4-a716-446655440000",
      "isAutoAchieved": true,
      "createdAt": "text",
      "employmentID": "550e8400-e29b-41d4-a716-446655440000",
      "expirationDate": "2025-03-12"
    }
  ],
  "deltaToken": "text",
  "pageToken": "text"
}

Successful request

get

/evidenceVariants/{id}

Authorizations

Path parameters

idstring · hexadecimal-integerrequired

Example: 550e8400-e29b-41d4-a716-446655440000

Pattern: ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/evidenceVariants/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

{
  "qualificationID": "550e8400-e29b-41d4-a716-446655440000",
  "lastModifiedAt": "text",
  "externalCode": "text",
  "createdAt": "text",
  "externalId": "text",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "code": "text",
  "name": "text",
  "interval": {}
}

Successful request

get

/groupings/{id}/definedGroupings

Authorizations

Path parameters

idstring · hexadecimal-integerrequired

Example: 550e8400-e29b-41d4-a716-446655440000

Pattern: ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$

Query parameters

pageTokenstring

limitinteger · int32

fieldsstring[]

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/groupings/{id}/definedGroupings' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

{
  "results": [
    {
      "code": "text",
      "lastModifiedAt": "text",
      "typeID": "550e8400-e29b-41d4-a716-446655440000",
      "externalCode": "text",
      "createdAt": "text",
      "description": "text",
      "externalId": "text",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "text",
      "definedInGroupingID": "550e8400-e29b-41d4-a716-446655440000",
      "interval": {}
    }
  ],
  "deltaToken": "text",
  "pageToken": "text"
}

Successful request

List all groupings viewable for API user

get

/groupings

Authorizations

Query parameters

pageTokenstring

limitinteger · int32

sinceDeltaTokenstring

fieldsstring[]

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/groupings' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

{
  "results": [
    {
      "code": "text",
      "lastModifiedAt": "text",
      "typeID": "550e8400-e29b-41d4-a716-446655440000",
      "externalCode": "text",
      "createdAt": "text",
      "description": "text",
      "externalId": "text",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "text",
      "definedInGroupingID": "550e8400-e29b-41d4-a716-446655440000",
      "interval": {}
    }
  ],
  "deltaToken": "text",
  "pageToken": "text"
}

Successful request

get

/groupings/{id}

Authorizations

Path parameters

idstring · hexadecimal-integerrequired

Example: 550e8400-e29b-41d4-a716-446655440000

Pattern: ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/groupings/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

{
  "code": "text",
  "lastModifiedAt": "text",
  "typeID": "550e8400-e29b-41d4-a716-446655440000",
  "externalCode": "text",
  "createdAt": "text",
  "description": "text",
  "externalId": "text",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "text",
  "definedInGroupingID": "550e8400-e29b-41d4-a716-446655440000",
  "interval": {}
}

Successful request

get

/groupingTypes/{id}

Authorizations

Path parameters

idstring · hexadecimal-integerrequired

Example: 550e8400-e29b-41d4-a716-446655440000

Pattern: ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/groupingTypes/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

{
  "name": "text",
  "externalCode": "text",
  "lastModifiedAt": "text",
  "createdAt": "text",
  "externalId": "text",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "code": "text"
}

Successful request

List all inProgressEntries viewable for API user

get

/inProgressEntries

Authorizations

Query parameters

pageTokenstring

limitinteger · int32

sinceDeltaTokenstring

fieldsstring[]

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/inProgressEntries' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

{
  "results": [
    {
      "remark": "text",
      "toDate": "2025-03-12",
      "lastModifiedAt": "text",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "plannedScoreOrder": 1,
      "closeDate": "2025-03-12",
      "qualificationID": "550e8400-e29b-41d4-a716-446655440000",
      "evidenceVariantID": "550e8400-e29b-41d4-a716-446655440000",
      "externalId": "text",
      "externalCode": "text",
      "fromDate": "2025-03-12",
      "createdAt": "text",
      "employmentID": "550e8400-e29b-41d4-a716-446655440000",
      "deadlineDate": "2025-03-12"
    }
  ],
  "deltaToken": "text",
  "pageToken": "text"
}

Successful request

get

/inProgressEntries/{id}

Authorizations

Path parameters

idstring · hexadecimal-integerrequired

Example: 550e8400-e29b-41d4-a716-446655440000

Pattern: ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/inProgressEntries/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

{
  "remark": "text",
  "toDate": "2025-03-12",
  "lastModifiedAt": "text",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "plannedScoreOrder": 1,
  "closeDate": "2025-03-12",
  "qualificationID": "550e8400-e29b-41d4-a716-446655440000",
  "evidenceVariantID": "550e8400-e29b-41d4-a716-446655440000",
  "externalId": "text",
  "externalCode": "text",
  "fromDate": "2025-03-12",
  "createdAt": "text",
  "employmentID": "550e8400-e29b-41d4-a716-446655440000",
  "deadlineDate": "2025-03-12"
}

Successful request

get

/groupingTypes/{id}/instances

Authorizations

Path parameters

idstring · hexadecimal-integerrequired

Example: 550e8400-e29b-41d4-a716-446655440000

Pattern: ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$

Query parameters

pageTokenstring

limitinteger · int32

fieldsstring[]

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/groupingTypes/{id}/instances' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

{
  "results": [
    {
      "code": "text",
      "lastModifiedAt": "text",
      "typeID": "550e8400-e29b-41d4-a716-446655440000",
      "externalCode": "text",
      "createdAt": "text",
      "description": "text",
      "externalId": "text",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "text",
      "definedInGroupingID": "550e8400-e29b-41d4-a716-446655440000",
      "interval": {}
    }
  ],
  "deltaToken": "text",
  "pageToken": "text"
}

Successful request

List all measurementSystems viewable for API user

get

/measurementSystems

Authorizations

Query parameters

pageTokenstring

limitinteger · int32

sinceDeltaTokenstring

fieldsstring[]

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/measurementSystems' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

{
  "results": [
    {
      "measurementValues": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "order": 1,
          "externalCode": "text",
          "createdAt": "text",
          "externalId": "text",
          "lastModifiedAt": "text",
          "code": "text",
          "name": "text"
        }
      ],
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "externalCode": "text",
      "createdAt": "text",
      "externalId": "text",
      "lastModifiedAt": "text",
      "scale": 1,
      "name": "text"
    }
  ],
  "deltaToken": "text",
  "pageToken": "text"
}

Successful request

get

/measurementSystems/{id}

Authorizations

Path parameters

idstring · hexadecimal-integerrequired

Example: 550e8400-e29b-41d4-a716-446655440000

Pattern: ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/measurementSystems/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

{
  "measurementValues": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "order": 1,
      "externalCode": "text",
      "createdAt": "text",
      "externalId": "text",
      "lastModifiedAt": "text",
      "code": "text",
      "name": "text"
    }
  ],
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "externalCode": "text",
  "createdAt": "text",
  "externalId": "text",
  "lastModifiedAt": "text",
  "scale": 1,
  "name": "text"
}

Successful request

get

/measurementSystems/{id}/qualifications

Authorizations

Path parameters

idstring · hexadecimal-integerrequired

Example: 550e8400-e29b-41d4-a716-446655440000

Pattern: ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$

Query parameters

pageTokenstring

limitinteger · int32

fieldsstring[]

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/measurementSystems/{id}/qualifications' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

{
  "results": [
    {
      "interval": {},
      "description": "text",
      "createdAt": "text",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "externalCode": "text",
      "evidenceVariants": [
        {
          "qualificationID": "550e8400-e29b-41d4-a716-446655440000",
          "lastModifiedAt": "text",
          "externalCode": "text",
          "createdAt": "text",
          "externalId": "text",
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "code": "text",
          "name": "text",
          "interval": {}
        }
      ],
      "lastModifiedAt": "text",
      "qualificationTypeID": "550e8400-e29b-41d4-a716-446655440000",
      "measurementSystemID": "550e8400-e29b-41d4-a716-446655440000",
      "name": "text",
      "externalId": "text",
      "code": "text"
    }
  ],
  "deltaToken": "text",
  "pageToken": "text"
}

Successful request

List all qualifications viewable for API user

get

/qualifications

Authorizations

Query parameters

pageTokenstring

limitinteger · int32

sinceDeltaTokenstring

fieldsstring[]

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/qualifications' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

{
  "results": [
    {
      "interval": {},
      "description": "text",
      "createdAt": "text",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "externalCode": "text",
      "evidenceVariants": [
        {
          "qualificationID": "550e8400-e29b-41d4-a716-446655440000",
          "lastModifiedAt": "text",
          "externalCode": "text",
          "createdAt": "text",
          "externalId": "text",
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "code": "text",
          "name": "text",
          "interval": {}
        }
      ],
      "lastModifiedAt": "text",
      "qualificationTypeID": "550e8400-e29b-41d4-a716-446655440000",
      "measurementSystemID": "550e8400-e29b-41d4-a716-446655440000",
      "name": "text",
      "externalId": "text",
      "code": "text"
    }
  ],
  "deltaToken": "text",
  "pageToken": "text"
}

Successful request

get

/qualifications/{id}

Authorizations

Path parameters

idstring · hexadecimal-integerrequired

Example: 550e8400-e29b-41d4-a716-446655440000

Pattern: ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/qualifications/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

{
  "interval": {},
  "description": "text",
  "createdAt": "text",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "externalCode": "text",
  "evidenceVariants": [
    {
      "qualificationID": "550e8400-e29b-41d4-a716-446655440000",
      "lastModifiedAt": "text",
      "externalCode": "text",
      "createdAt": "text",
      "externalId": "text",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "code": "text",
      "name": "text",
      "interval": {}
    }
  ],
  "lastModifiedAt": "text",
  "qualificationTypeID": "550e8400-e29b-41d4-a716-446655440000",
  "measurementSystemID": "550e8400-e29b-41d4-a716-446655440000",
  "name": "text",
  "externalId": "text",
  "code": "text"
}

Successful request

get

/measurementValues/{id}

Authorizations

Path parameters

idstring · hexadecimal-integerrequired

Example: 550e8400-e29b-41d4-a716-446655440000

Pattern: ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/measurementValues/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "order": 1,
  "externalCode": "text",
  "createdAt": "text",
  "externalId": "text",
  "lastModifiedAt": "text",
  "code": "text",
  "name": "text"
}

Successful request

get

/positions/{id}

Authorizations

Path parameters

idstring · hexadecimal-integerrequired

Example: 550e8400-e29b-41d4-a716-446655440000

Pattern: ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/positions/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "interval": {},
  "externalCode": "text",
  "createdAt": "text",
  "externalId": "text",
  "lastModifiedAt": "text",
  "employmentID": "550e8400-e29b-41d4-a716-446655440000",
  "tagIDs": [
    "550e8400-e29b-41d4-a716-446655440000"
  ]
}

Successful request

get

/qualifications/{id}/achievements

Authorizations

Path parameters

idstring · hexadecimal-integerrequired

Example: 550e8400-e29b-41d4-a716-446655440000

Pattern: ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$

Query parameters

pageTokenstring

limitinteger · int32

fieldsstring[]

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/qualifications/{id}/achievements' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

{
  "results": [
    {
      "remark": "text",
      "lastModifiedAt": "text",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "issueDate": "2025-03-12",
      "overriddenExpirationDate": "2025-03-12",
      "qualificationID": "550e8400-e29b-41d4-a716-446655440000",
      "evidenceVariantID": "550e8400-e29b-41d4-a716-446655440000",
      "externalId": "text",
      "documents": [
        {
          "contentType": "text",
          "filename": "text"
        }
      ],
      "externalCode": "text",
      "scoreOrder": 1,
      "submittedByID": "550e8400-e29b-41d4-a716-446655440000",
      "approvedByID": "550e8400-e29b-41d4-a716-446655440000",
      "isAutoAchieved": true,
      "createdAt": "text",
      "employmentID": "550e8400-e29b-41d4-a716-446655440000",
      "expirationDate": "2025-03-12"
    }
  ],
  "deltaToken": "text",
  "pageToken": "text"
}

Successful request

get

/qualifications/{id}/inProgressEntries

Authorizations

Path parameters

idstring · hexadecimal-integerrequired

Example: 550e8400-e29b-41d4-a716-446655440000

Pattern: ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$

Query parameters

pageTokenstring

limitinteger · int32

fieldsstring[]

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/qualifications/{id}/inProgressEntries' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

{
  "results": [
    {
      "remark": "text",
      "toDate": "2025-03-12",
      "lastModifiedAt": "text",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "plannedScoreOrder": 1,
      "closeDate": "2025-03-12",
      "qualificationID": "550e8400-e29b-41d4-a716-446655440000",
      "evidenceVariantID": "550e8400-e29b-41d4-a716-446655440000",
      "externalId": "text",
      "externalCode": "text",
      "fromDate": "2025-03-12",
      "createdAt": "text",
      "employmentID": "550e8400-e29b-41d4-a716-446655440000",
      "deadlineDate": "2025-03-12"
    }
  ],
  "deltaToken": "text",
  "pageToken": "text"
}

Successful request

get

/qualificationTypes/{id}

Authorizations

Path parameters

idstring · hexadecimal-integerrequired

Example: 550e8400-e29b-41d4-a716-446655440000

Pattern: ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/qualificationTypes/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

{
  "name": "text",
  "externalCode": "text",
  "lastModifiedAt": "text",
  "createdAt": "text",
  "externalId": "text",
  "id": "550e8400-e29b-41d4-a716-446655440000"
}

Successful request

get

/qualificationTypes/{id}/qualifications

Authorizations

Path parameters

idstring · hexadecimal-integerrequired

Example: 550e8400-e29b-41d4-a716-446655440000

Pattern: ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$

Query parameters

pageTokenstring

limitinteger · int32

fieldsstring[]

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/qualificationTypes/{id}/qualifications' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

{
  "results": [
    {
      "interval": {},
      "description": "text",
      "createdAt": "text",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "externalCode": "text",
      "evidenceVariants": [
        {
          "qualificationID": "550e8400-e29b-41d4-a716-446655440000",
          "lastModifiedAt": "text",
          "externalCode": "text",
          "createdAt": "text",
          "externalId": "text",
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "code": "text",
          "name": "text",
          "interval": {}
        }
      ],
      "lastModifiedAt": "text",
      "qualificationTypeID": "550e8400-e29b-41d4-a716-446655440000",
      "measurementSystemID": "550e8400-e29b-41d4-a716-446655440000",
      "name": "text",
      "externalId": "text",
      "code": "text"
    }
  ],
  "deltaToken": "text",
  "pageToken": "text"
}

Successful request

AG5 API Glossary

This Glossary provides definitions for key terms used in the AG5 API. This section helps users understand important concepts, data structures and terminology relevant to AG5 API integration.

Achievements

Contract Types

GET /contractTypes – Retrieves a list of all contract types available to the API user. Supports pagination using deltaToken and pageToken.
GET /contractTypes/{id} – Fetches details of a specific contract type by its unique id.

These endpoints allow organizations to standardize and manage contract classifications within their HR or workforce management systems.

AG5 API Description

Welcome to the AG5 API Frequently Asked Questions (FAQ) page. Here, you’ll find answers to common inquiries regarding our API capabilities, data updates and integration requirements.

Does AG5 support custom reports for API integration?

Yes, AG5 can support custom reports; however, this is not a standard use case. If you require a custom reporting solution, please contact our team to discuss specific requirements and feasibility.

How frequently does the AG5 API update?

The AG5 API updates every hour, ensuring that data remains current and synchronized.

What is required on the customer's side to connect to the AG5 API?

Customers must set up an ETL (Extract, Transform, Load) pipeline within their own infrastructure. This typically requires involvement from their Data/IT department to:

Extract data from the AG5 API
Store it in their data warehouse
Connect the warehouse to Power BI or another BI tool for visualization and analysis

For more details on API integration, please refer to our technical documentation.

get

/qualifications/{id}/evidenceVariants

Authorizations

Path parameters

idstring · hexadecimal-integerrequired

Example: 550e8400-e29b-41d4-a716-446655440000

Pattern: ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$

Query parameters

pageTokenstring

limitinteger · int32

fieldsstring[]

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/qualifications/{id}/evidenceVariants' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

{
  "results": [
    {
      "qualificationID": "550e8400-e29b-41d4-a716-446655440000",
      "lastModifiedAt": "text",
      "externalCode": "text",
      "createdAt": "text",
      "externalId": "text",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "code": "text",
      "name": "text",
      "interval": {}
    }
  ],
  "deltaToken": "text",
  "pageToken": "text"
}

Successful request

AG5 API

API reference

Achievements

ContractTypes

EmploymentContracts

EmploymentContracts

EmploymentRelations

Employments

Achievements

ApprovedAchievements

InProgressEntries

Positions

ReferringRelations

SubmittedAchievements

EmploymentUnavailabilities

EvidenceVariants

Achievements

InProgressEntries

Groupings

DefinedGroupings

GroupingTypes

Instances

InProgressEntries

MeasurementSystems

Qualifications

MeasurementValues

Positions

Qualifications

Achievements

EvidenceVariants

InProgressEntries

QualificationTypes

Qualifications

ServiceIsAvailable

ServiceVersion

AG5 API Description

Does AG5 support custom reports for API integration?

How frequently does the AG5 API update?

What is required on the customer's side to connect to the AG5 API?

AG5 API Glossary

Achievements

Contract Types

Achievements

List all achievements viewable for API user

Achievements

ContractTypes

EmploymentContracts

ApprovedAchievements

Employments

EmploymentContracts

ReferringRelations

Positions

EmploymentRelations

InProgressEntries

InProgressEntries

Achievements

EmploymentUnavailabilities

SubmittedAchievements

EvidenceVariants

DefinedGroupings

Groupings

GroupingTypes

InProgressEntries

Instances

MeasurementSystems

Qualifications

Qualifications

MeasurementValues

Positions

Achievements

InProgressEntries

QualificationTypes

Qualifications

ServiceVersion

List all contractTypes viewable for API user

List all employmentContracts viewable for API user

List all employments viewable for API user

List all employmentRelations viewable for API user

List all employmentUnavailabilities viewable for API user

List all evidenceVariants viewable for API user