Get Enrolled

Get Enrolled

Use this endpoint to return the list of individual UUIDs currently enrolled in a benefit. If no one is enrolled, individual_ids is an empty array.

Key Points

• Depends on — a benefit_id from POST /benefits or GET /benefits.
• Next step — pass the returned individual_id values to GET /benefits/{benefit_id}/individuals to read deduction configuration.

GET benefits/{benefit_id}/enrolled 

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.

Query Parameters

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

Path Parameters

Field	Type	Description
benefit_id	string	The benefit UUID from the create or list endpoints.

Response Body

Field	Type	Description
status	string	SUCCESS or FAILURE.
status_code	number	HTTP-style status code (e.g. 200, 400).
message	string	Human-readable status message.
response	object	The enrollment result.
benefit_id	string	Benefit UUID.
individual_ids	string[]	UUIDs of individuals currently enrolled. Empty array if none enrolled.

Payload

Request

GET benefits/e8b90071-0c11-471c-86e8-e303ef2f6782/enrolled?entity_ids=519a84f4-5e56-496a-82f3-18f51fdf3d75
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 entity_ids or benefit_id is missing or invalid.
404	Not Found Response - You'll get the below response when no benefit matches the supplied benefit_id.

{
  "status": "SUCCESS",
  "status_code": 200,
  "message": "Request processed successfully",
  "response": {
    "benefit_id": "e8b90071-0c11-471c-86e8-e303ef2f6782",
    "individual_ids": [
      "7a3f1c2d-11bb-4e6a-9c0d-f83a57e12346",
      "9b2e4d7f-22cc-5f7b-0d1e-994b68f23457"
    ]
  }
}