List Employee Groups
Header Parameters
Optional correlation ID for distributed tracing.
Query Parameters
Zero-based page index. Defaults to 0.
Number of items per page. Defaults to 20, max 100.
Optional filter by group status.
Optional employer account identifier to filter by. Ignored when the caller's JWT carries an employer claim (typical for employer-scoped user/service tokens); if supplied and it does not match the JWT claim, the request is rejected with 403 Forbidden. When the JWT does not carry an employer claim (e.g., partner/TPA or admin tooling authenticating via OAuth2Client client-credentials or ApiKeyAuth), this parameter identifies the target tenant and the caller's scope must grant access...
Response
OK – Paginated list of employee groups
Response Attributes
Employee group records for the current page.
Show child attributes
Zero-based page index.
Number of items per page.
True if more pages exist.
Show child attributes
Bad Request – Validation failed. The errors map keys mirror the snake_case JSON property names used in the request payload.
Response Attributes
List of invalid parameters that caused the validation error.
Show child attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Show child attributes
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.
Unauthorized – Missing or invalid credentials.
Response Attributes
List of invalid parameters that caused the validation error.
Show child attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.
Forbidden – Insufficient permissions.
Response Attributes
List of invalid parameters that caused the validation error.
Show child attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.
Too Many Requests – Rate limit exceeded.
Response Attributes
List of invalid parameters that caused the validation error.
Show child attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.
Internal Server Error.
Response Attributes
List of invalid parameters that caused the validation error.
Show child attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.
Internal Server Error.
Response Attributes
List of invalid parameters that caused the validation error.
Show child attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.