Benefit usage
List Benefit Usages
Lists Benefit Usages
Authorization
HTTPBearer AuthorizationBearer <token>
In: header
Query Parameters
name?|
Filter by meter_event_name on the linked benefit (meter benefits).
member_ids?array<>|
Filter by one or more internal member IDs. Repeat the parameter for multiple members.
page?integer
Page number
Default
1Range
1 <= valuesize?integer
Page size
Default
50Range
1 <= value <= 100Response Body
application/json
application/json
curl -X GET "https://api.members.dev/portal/v1/benefit-usages"{
"items": [
{
"id": "string",
"short_id": "string",
"timestamp": 0,
"benefit_id": "string",
"benefit_grant_id": "string",
"payload": {
"value": 0
},
"external_id": "string",
"member_id": "string",
"external_member_id": "string",
"amount_allocated": 0,
"allocation_status": "unallocated",
"created_at": null,
"updated_at": null
}
],
"total": 0,
"page": 1,
"size": 1,
"pages": 0
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string",
"input": null,
"ctx": {}
}
]
}