Get Employee Group By Id
Header Parameters
Optional correlation ID for distributed tracing.
Path Parameters
Employee group external identifier (UUID v4). No internal numeric identifier is exposed on the wire.
Response
OK – Employee group found
Response Attributes
Public UUID for cross-domain references and API addressing (used as the {id} path parameter). No internal numeric identifier is exposed on the wire.
Unique code for this group within the employer account.
Human-readable name for the employee group.
Optional description of the group's purpose.
Current status of the employee group.
Date the group becomes effective (YYYY-MM-DD).
Date the group was terminated (YYYY-MM-DD).
Employer account identifier this group belongs to.
Show child attributes
Show child attributes
Active membership rules for this group.
Show child attributes
Number of employees currently matched by this group's rules.
Identity of the principal who created the record.
Identity of the principal who last modified the record.
ISO 8601 timestamp of record creation.
ISO 8601 timestamp of last modification.
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.
Not Found – Employee record does not exist.
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.