Get all groups

Gets all groups and users in the groups.

Note: The Collections Window, Notes, Advanced Payment Manager, Payment Plans, and Statement Generator features are entering end of support on June 3, 2024. For more information, please refer to the Product and Feature End of Support page.

Request

header Parameters

API-Token

required

string

The API token that is shown in the settings of Notes. It is a 64-digit hex number.

Example: a48865e51c3f4610de8f319bdd7bf691b2aaad827ed31ad1dd6847e617200666

Responses

200

get/api/v1/groups

Request samples

cURL

Response samples

application/json

{"success": true,
"groups": {"id": 113,
"name": "NYC Office",
"description": "Engineers in NYC",
"created_at": "2020-02-12T21:50:59.774Z",
"updated_at": "2020-02-12T21:50:59.774Z",
"users": [{"id": 5,
"username": "vina@megan.sbx",
"connect_identity": "2c92c0f96512a90f01651a566d4250f7",
"email": "asdfa@yahoo.com",
"firstname": "Vina",
"lastname": "Lim",
"platformrole": "ADMIN",
"timezone": "America/New_York",
"created_at": "2020-01-09T13:41:05.662Z",
"updated_at": "2020-01-30T15:46:17.063Z",
"escalation_user_id": "2c92c0f96512a90f01651a566d4250f8",
"escalation_user": "Vina LimEscalation",
"approval_amount": 0,
"image": {"url": "https://rbm-apps.s3.amazonaws.com/Notes/staging/2020012309011579791462.jpg"
}
}
]
}
}