Employee Requirements

Authentication: All endpoints require an Authorization: Bearer <access token> header.

Most endpoints require an X-Company-ID: <company_id> header to scope requests to a specific company. This is the recommended header for most API operations.

Some endpoints require an X-Location-ID: <location_id> header when the query doesn't accept a locationId parameter.

See Authentication for details on how to obtain and use these headers.

Query Employee Requirements

Get all requirements for a specific employee. Requirements include certifications, licenses, and other compliance documents that employees may be required to provide their employer.

Query Parameters:

Parameter	Type	Required	Description
`employeeId`	`ID!`	Yes	The ID of the employee to query

Response Fields:

Field	Description
`id`	Unique identifier for the employee requirement
`employee.id`	Employee ID
`employee.fullName`	Full name of the employee
`requirement.id`	ID of the requirement type
`requirement.name`	Name of the requirement (e.g., "Certificate", "First Aid")
`requirement.abbreviation`	Short code for the requirement
`requirement.expires`	Whether this requirement type expires
`requirement.evidence`	Whether evidence/attachment is required
`name`	Custom name for this specific requirement instance
`reference`	Reference number or identifier
`state`	State/region where the requirement is valid
`expiresAt`	Expiration date (if applicable)
`attachment.id`	ID of the attached evidence document (if any)

For the complete EmployeeRequirement type reference and all available fields, see the GraphQL Schema Reference.

Implementation Notes:

Requirements are defined at the company/location level and assigned to employees
The requirement object contains the template/type definition, while the parent object contains the employee-specific data
If requirement.expires is true, the expiresAt field should be populated
If requirement.evidence is true, an attachment should be linked
The state field indicates where the requirement is valid (e.g., state-specific licenses)
Requirements without attachments may still be valid if the requirement type doesn't require evidence

GraphQL Query

query EmployeeRequirement($employeeId: ID!) {
  employeeRequirements(employeeId: $employeeId) {
    id
    employee {
      id
      fullName
    }
    requirement {
      id
      name
      abbreviation
      expires
      evidence
    }
    name
    reference
    state
    expiresAt
    attachment {
      id
    }
  }
}

Example Variables

{
  "employeeId": "73544"
}

Example Response

{
  "data": {
    "employeeRequirements": [
      {
        "id": "7030",
        "employee": {
          "id": "73544",
          "fullName": "Alana Robertson"
        },
        "requirement": {
          "id": "40",
          "name": "Certificate",
          "abbreviation": "CERT",
          "expires": false,
          "evidence": true
        },
        "name": null,
        "reference": "QUT3423111231",
        "state": "QLD",
        "expiresAt": null,
        "attachment": {
          "id": "251780"
        }
      },
      {
        "id": "7031",
        "employee": {
          "id": "73544",
          "fullName": "Alana Robertson"
        },
        "requirement": {
          "id": "41",
          "name": "First Aid",
          "abbreviation": "AID",
          "expires": true,
          "evidence": false
        },
        "name": null,
        "reference": "AID00-1231123",
        "state": "QLD",
        "expiresAt": "2024-06-24",
        "attachment": null
      }
    ]
  }
}