Skip to main content
GET
Get Team Credit Use History

Get Team Credit Use History

Returns a paged list of the benefit uses of every member of the team: booking time, money credit and printing credit, plus a row for credit lost when a benefit expired with credit left. It covers every member’s benefits, shared with the team or not, as the team Benefits page in the Nexudus dashboard does. The portal uses it for the Booking time and credit use history section of the team Benefits page. The records have the same fields as Get Customer Credit Use History. Passes are not included.

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

string
The kind of benefit to return: "BookingTime", "Credit" or "Printing" (case-insensitive). Leave it out to return every kind together. Any other value returns 400 Bad Request.
string
Only return uses of benefits with this name. Use a value from Filters.Benefits[].Name.
number
Only return uses by this team member. Use a value from Filters.Members[].Id.
number
default:"1"
Page number, starting at 1.
number
default:"25"
Number of records per page.
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

A standard paged list plus the filter options, sorted by IssuedFor, then UsedFromUtc, both newest first. There is no date limit. See Get Customer Credit Use History for the fields of each record.
BenefitUsageRecord[]
required
The uses on the requested page. UsedById and UsedByFullName say which team member used each benefit.
array
Every benefit with at least one use, as { Name, Kind }. Built before any filter is applied.
array
Every team member with at least one use, as { Id, FullName }. Built before any filter is applied.

Example Request

Usage in Portal

Error Responses

error
kind is not BookingTime, Credit or Printing.
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.