members.dev
Benefit usage

List benefit usage rows

GET
/v1/benefit-usages

Authorization

HTTPBearer
AuthorizationBearer <token>

In: header

Query Parameters

name?|

Filter by meter_event_name on the linked benefit (meter benefits).

user_ids?array<>|

Filter by one or more internal user IDs. Repeat the parameter for multiple users.

page?integer

Page number

Default1
Range1 <= value
size?integer

Page size

Default50
Range1 <= value <= 100

Response Body

application/json

application/json

curl -X GET "https://api.members.dev/v1/benefit-usages"
{
  "items": [
    {
      "id": "string",
      "timestamp": 0,
      "benefit_id": "string",
      "benefit_grant_id": "string",
      "payload": {
        "value": 0
      },
      "external_id": "string",
      "user_id": "string",
      "external_user_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": {}
    }
  ]
}