Skip to main content
GET
Get Team Benefits

Get Team Benefits

Returns the current benefits of every member of the team, whether or not they are shared with the team. This matches the team Benefits page in the Nexudus dashboard. The portal uses it for the Current benefits section of the team Benefits page. The response has the same shape as GET /api/public/coworkers/profiles/current/benefits: the team’s benefits are in Team, and Personal is always empty.

Authentication

Requires a valid customer bearer token. The customer must be a team administrator of the specified team.

Path Parameters

number
required
Numeric identifier of the team. Returned as Id from GET /api/public/teams/my.

Query Parameters

boolean
default:"false"
When true, fully used benefits that are still valid move to the end of each list, and the rest keep their order. See Get Customer Benefits for when a benefit counts as fully used. Expired benefits are never returned.
string
Comma-separated list of field paths to include in the response. When provided, only the specified fields are returned — useful for reducing payload size. Supports nested paths using dot notation.

Response

object
Always empty: BookingCredits, ExtraServices and TimePasses are empty arrays.
array
Booking credits of all team members. Same fields as Personal.BookingCredits in Get Customer Benefits, with Kind always "Credit".
array
Booking time and printing credits of all team members. Kind is "Printing" for printing credits, otherwise "BookingTime".
array
Passes of all team members, with Kind always "Pass".
object
The team member who owns the benefit, on every booking credit, extra service and pass: Id and FullName only. The portal shows it in the Member column of the team’s current benefits.

Example Request

Usage in Portal

Error Responses

error
The bearer token is missing, expired, or invalid, or the customer is not a team administrator of this team.
error
No team exists with this teamId.