Skip to content

List staff

Request

Staff directory and human resource management with organizational structure

This comprehensive HR endpoint provides complete staff management including:

  • Employee directory with advanced search capabilities
  • Department and organizational structure integration
  • Role-based staff categorization and filtering
  • Active/inactive employee status management
  • Multi-field name search with partial matching

HR Management Capabilities:

  • Complete employee directory with contact information
  • Department-based organizational structure tracking
  • Staff type and role classification system
  • Active employee status for current workforce analysis
  • Employee search across first and last names

Organizational Features:

  • Department hierarchy and staff allocation
  • Role-based access and staff type categorization
  • Employee status management (active/inactive)
  • Contact information and communication data
  • Staff reference and external system integration

Search and Filter Options:

  • Multi-field name search (first name, last name)
  • Department-based staff filtering
  • Active status filtering for current employees
  • Role and staff type categorization
  • Alphabetical sorting for directory listings

Business Applications:

  • Employee directory and contact management
  • HR reporting and organizational analysis
  • Department staff allocation and planning
  • Employee onboarding and management workflows
  • Integration with external HR and payroll systems

Directory Features:

  • Complete contact information management
  • Department and role relationship tracking
  • Staff reference system for external integration
  • Employee status and lifecycle management

Real Example:

curl --location 'https://{{host}}/v1/staff' \
--data '{
  "pageSize": 25,
  "page": 0
}'

Permissions:

Security
BearerAuth
Bodyapplication/json
pageSizeinteger, [ 1 .. 1000 ]

Maximum number of staff records to return

Default:25
Example:25
pageinteger, >= 0

Page number for pagination (0-based)

Default:0
Example:0
isActiveboolean

Filter by active employee status

Example:true
departmentIdinteger

Filter staff by specific department ID

Example:7
nameSearchstring

Search term for first and last names (use % for wildcard)

Example:"%"
sortOrderstring

Sort order for staff names

Default:"asc"
Enum:"asc""desc"
Example:"asc"
curl -i -X POST \
  https://api.doc.aiwyn.ai/_mock/bundle/gql/v1/staff \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "pageSize": 25,
    "page": 0
  }'

Responses

Successfully retrieved staff records

Bodyapplication/json
deid_staffArray of objects
deid_staff_aggregateobject
Response
{
  "deid_staff": [
    { … },
    { … },
    { … }
  ],
  "deid_staff_aggregate": {
    "aggregate": { … }
  }
}