Team
This section describes the endpoints for interacting with teams.
Get teams
GET {{BASE_URL}}/admin/api/teams
Get all accounts
Query Parameters
Name
Type
Description
page*
String
1
limit*
String
10
Headers
Name
Type
Description
Api-Key*
String
Admin api key
{
"docs": [
{
"_id": "6548a41f38406c14db33b61e",
"name": "My Team",
"email": "[email protected]",
"members": [
{
"user": {
"_id": "6548a41138406c14db33b606",
"status": 0,
"hubspotContactId": "131751",
"name": "John Doe",
"email": "[email protected]",
"stripeId": "cus_OxIokju2aarNVm"
},
"role": 0
}
],
"createdAt": "2023-11-06T08:30:23.529Z",
"updatedAt": "2023-11-06T12:56:06.337Z",
"billingSettings": {
"_id": "6548e2660919dc0442dc2ec7",
"user": "6548a41138406c14db33b606",
"__v": 0,
"address1": "test1",
"address2": "Test",
"city": "Test",
"company": "Rezet",
"country": "Afghanistan",
"createdAt": "2023-11-06T12:56:06.296Z",
"state": "Test",
"taxId": null,
"updatedAt": "2023-11-07T10:18:39.676Z",
"zip": "34334"
},
"id": "6548a41f38406c14db33b61e",
"status": "customer"
},
{
"_id": "6549ff7ce58641429600ac91",
"name": "DEV Team1",
"email": "[email protected]",
"members": [
{
"user": {
"_id": "6548a41138406c14db33b606",
"status": 0,
"hubspotContactId": "131751",
"name": "John Doe",
"email": "[email protected]",
"stripeId": "cus_OxIokju2aarNVm"
},
"role": 0
}
],
"createdAt": "2023-11-06T08:30:23.529Z",
"updatedAt": "2023-11-07T09:55:26.348Z",
"billingSettings": {
"_id": "6548e2660919dc0442dc2ec7",
"user": "6548a41138406c14db33b606",
"__v": 0,
"address1": "test1",
"address2": "Test",
"city": "Test",
"company": "Rezet",
"country": "Afghanistan",
"createdAt": "2023-11-06T12:56:06.296Z",
"state": "Test",
"taxId": null,
"updatedAt": "2023-11-07T10:18:39.676Z",
"zip": "34334"
},
"id": "6549ff7ce58641429600ac91",
"status": "customer"
},
{
"_id": "654a094970c99a149c791fc7",
"name": "My Team",
"email": "[email protected]",
"members": [
{
"user": {
"_id": "654a093e70c99a149c791faf",
"status": 0,
"hubspotContactId": "206501",
"name": "John Doe",
"email": "[email protected]",
"stripeId": "cus_OxhNYBXJyLjbnU"
},
"role": 0
}
],
"createdAt": "2023-11-07T09:54:17.095Z",
"updatedAt": "2023-11-07T09:54:17.095Z",
"id": "654a094970c99a149c791fc7",
"status": "prospect"
}
],
"totalDocs": 3,
"limit": 10,
"totalPages": 1,
"page": 1,
"pagingCounter": 1,
"hasPrevPage": false,
"hasNextPage": false,
"prevPage": null,
"nextPage": null
}Get team
GET {{BASE_URL}}/admin/api/teams/{id}
Get a specific team
Path Parameters
Name
Type
Description
id*
String
Team ID
Headers
Name
Type
Description
Api-Key*
String
Admin api key
Get team costs
GET {{BASE_URL}}/admin/api/teams/{id}/costs
Get a cost estimate for a specific team.
Path Parameters
Name
Type
Description
id*
String
Team ID
Headers
Name
Type
Description
Api-Key*
String
Admin api key
Get team billing history
GET {{BASE_URL}}/admin/api/teams/{id}/
Get all invoices for a specific team.
Path Parameters
Name
Type
Description
id*
String
Team ID
Query Parameters
Name
Type
Description
page*
String
1
Headers
Name
Type
Description
Api-Key*
String
Admin api key
Last updated
Was this helpful?