List
List
This endpoint can be used to retrieve the list of team members assigned to a specific business or group.
GET TeamMember/List Request Params
| Field | Type | Description |
|---|---|---|
| BusinessId | Guid | A unique identifier of the Business |
| PayerRef | string | A Unique reference of the payer |
| GroupId | Guid | A Unique identifier of the group generated by Taxbandits |
| GroupRef | string | Unique reference of the group |
| GroupNm | string | Name of the group |
Response Body
| Field | Type | Description |
|---|---|---|
| TeamMemberRecords | object[] | Object to identify the team member details |
| BusinessId | Guid | Returns unique identifier of the Business |
| PayerRef | string | Returns unique reference of the payer |
| GroupId | Guid | Returns unique identifier of the group |
| GroupRef | string | Returns unique reference of the group |
| MemberId | Guid | A unique identifier of the team member generated by Taxbandits |
| MemberRole | string | Assigned role for the team member |
| MemberRef | string | Returns unique reference for the team member |
| Status | string | Returns the invite status of the team member |
| StatusTs | string | Returns the date and time of the team member invite |
| TotalRecords | number | Total number of records listed in the response |
| TotalPages | number | Total number of pages |
| Page | number | Returns the page number on which the records are listed |
| PageSize | number | Number of records listed on each page |
| Errors | object[] | Shows the error information of state returns |
| Id | string | Returns the validation error ID |
| Name | string | Name of the validation error |
| Message | string | Description of the validation error |
Request Params
"TeamMember/List?GroupId=2878&BusinessId=66c8364f-f59a-4592-9d21-38b91dcf1c99"
Response JSON
Success Response - This is a sample response for successful API requests.
{
"TeamMemberRecords": [
{
"BusinessId": "b11b1df1-bb1a-4b5a-b593-7cceb6aaa369",
"PayerRef": "Snow12345",
"GroupId": 12897,
"GroupRef": null,
"MemberId": "70cbd19e-7b25-42fb-9581-bfcf9a24f059",
"MemberRole": "TEAM_MEMBER",
"MemberRef": null,
"Status": "INVITED",
"StatusTs": "2026-01-13 18:45:03 -05:00"
}
],
"Page": 1,
"TotalRecords": 1,
"TotalPages": 1,
"PageSize": 100,
"Errors": null
}