Skip to main content
Version: 1.7.3

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

FieldTypeDescription
    BusinessIdGuidA unique identifier of the Business
    PayerRefstringA Unique reference of the payer
    GroupIdGuidA Unique identifier of the group generated by Taxbandits
    GroupRefstringUnique reference of the group
    GroupNmstringName of the group

Response Body

FieldTypeDescription
    TeamMemberRecordsobject[]Object to identify the team member details
    BusinessIdGuidReturns unique identifier of the Business
    PayerRefstringReturns unique reference of the payer
    GroupIdGuidReturns unique identifier of the group
    GroupRefstringReturns unique reference of the group
    MemberIdGuidA unique identifier of the team member generated by Taxbandits
    MemberRolestringAssigned role for the team member
    MemberRefstringReturns unique reference for the team member
    StatusstringReturns the invite status of the team member
    StatusTsstringReturns the date and time of the team member invite
    TotalRecordsnumberTotal number of records listed in the response
    TotalPagesnumberTotal number of pages
    PagenumberReturns the page number on which the records are listed
    PageSizenumberNumber of records listed on each page
    Errorsobject[]Shows the error information of state returns
        IdstringReturns the validation error ID
        NamestringName of the validation error
        MessagestringDescription 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
}