Get Pay Group Details

Get Pay Group Details

Use this endpoint to retrieve full details for a single pay group, including the list of employees assigned to it. Provide the pay_group_id from GET /payroll/pay-groups in the path.

GET payroll/pay-groups/{pay_group_id} 

Header Parameters

Field	Type	Description
Authorization	string	Required. Bearer token obtained from the Auth endpoint. Format: Bearer <access_token>.
X-TaxBandits-Version	string	API version string. Use 1.0.0.

Path Parameters

Field	Type	Description
pay_group_id	string	UUID from GET /payroll/pay-groups. Required.

Query Parameters

Field	Type	Description
entity_ids	string	Required. The organization ID. Must be exactly one UUID.

Response Body

Field	Type	Description
status	string	SUCCESS or FAILURE.
status_code	number	HTTP status code (e.g. 200).
message	string	Human-readable status message.
response	object	The pay group details.
id	string	The pay group UUID (pay_group_id).
name	string	Name of the pay group.
pay_frequencies	string[]	Pay frequencies for this group (e.g. ["bi_weekly"]).
individual_ids	string[]	Employee UUIDs (individual_id) assigned to this pay group.

Payload

Request

GET payroll/pay-groups/a1b2c3d4-1111-2222-3333-444455556666?entity_ids=519a84f4-...
Header: X-TaxBandits-Version: 1.0.0

Response Json

Sample	Description	Action
200	Success Response - This is a sample response for successful API requests.
400	Bad Request Response - You'll get the below response when pay_group_id or entity_ids is missing or invalid.

{
  "status": "SUCCESS",
  "status_code": 200,
  "message": "Request processed successfully",
  "response": {
    "id": "a1b2c3d4-1111-2222-3333-444455556666",
    "name": "Bi-Weekly Group",
    "pay_frequencies": [
      "bi_weekly"
    ],
    "individual_ids": [
      "7a3f1c2d-11bb-4e6a-9c0d-f83a57e12346",
      "9b2e4d7f-22cc-5f7b-0d1e-994b68f23457"
    ]
  }
}