Skip to main content
GET
/
api
/
external
/
staffs
List staff
curl --request GET \
  --url https://gateway-api.guardhousehq.com/api/external/staffs \
  --header 'Authorization: Bearer <token>'
{
  "status": {
    "code": 123,
    "errorMessage": "<string>"
  },
  "data": [
    {
      "id": 123,
      "firstName": "<string>",
      "lastName": "<string>",
      "middle": "<string>",
      "email": "jsmith@example.com",
      "mobile": "<string>",
      "employeeId": "<string>",
      "accessPriviledge": "<string>",
      "subcontractorName": "<string>",
      "employeeReferenceNumber": "<string>",
      "gender": "<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>.

Query Parameters

searchText
string

Free-text filter across staff name and identifier columns.

isActive
boolean
default:true

When true (default), only return active staff.

referenceId
integer<int32>

Cursor anchor ID. Pass the last incidentReportId (or equivalent) you saw to fetch the next page.

referenceName
string

Cursor anchor name when paginating across results sorted by name.

limit
integer<int32>
default:20

Maximum number of records to return.

direction
enum<string>
default:next

Cursor pagination direction. Use next to page forward and prev to page back.

Available options:
next,
prev
filter
string

Response

Paginated list of staff

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