Skip to main content
GET
/
api
/
external
/
staffs
/
{id}
/
licenses
List a staff member's security licenses
curl --request GET \
  --url https://gateway-api.guardhousehq.com/api/external/staffs/{id}/licenses \
  --header 'Authorization: Bearer <token>'
{
  "status": {
    "code": 123,
    "errorMessage": "<string>"
  },
  "data": [
    {
      "securityLicenseId": 123,
      "employeeId": 123,
      "firstName": "<string>",
      "lastName": "<string>",
      "state": "<string>",
      "licenseNumber": "<string>",
      "status": "<string>",
      "expiryDate": "2023-11-07T05:31:56Z",
      "reminder": 123,
      "critical": true,
      "attachmentLink": "<string>",
      "licenceSector": "<string>",
      "isInvalidLicense": true,
      "employeeSecurityLicenseInfo": {
        "employeeSecurityLicenseId": 123,
        "currentStatus": "<string>",
        "expiryDate": "2023-11-07T05:31:56Z",
        "licenceSector": "<string>"
      }
    }
  ],
  "count": 123,
  "message": "<string>",
  "errors": [
    {
      "code": 100,
      "message": "<string>"
    }
  ],
  "nextPageParameter": "<string>",
  "prevPageParameter": "<string>"
}

Authorizations

​
Authorization
string
header
required

JWT issued by POST /api/token/request. Send as Authorization: Bearer <token>.

Path Parameters

​
id
integer<int32>
required

Employee ID.

Query Parameters

​
licenseNumber
string

Optional filter to a specific license number.

Response

Paginated list of security licenses

Envelope for the newer cursor-paginated endpoints (timesheets, staff, customers, sites). The cursor is encoded as a string in nextPageParameter / prevPageParameter and is intended to be POSTed back as the next request body — or appended to the query string verbatim.

​
status
object
​
data
object[]

Endpoint-specific payload. null when an error occurred.

​
count
integer<int32> | null
​
message
string
​
errors
object[]
​
nextPageParameter
string | null
​
prevPageParameter
string | null