Benefit grants
List Benefit Grants
List benefit grants with optional filters (e.g. by user).
Authorization
HTTPBearer AuthorizationBearer <token>
In: header
Query Parameters
user_ids?array<>|
Filter grants to one or more user IDs. Provide the parameter multiple times for multiple users.
statuses?array<>|
Filter grants to one or more lifecycle statuses. Provide the parameter multiple times.
benefit_ids?array<>|
Filter grants to one or more benefit IDs. Provide the parameter multiple times.
subscription_ids?array<>|
Filter grants to one or more subscription IDs. Provide the parameter multiple times.
product_ids?array<>|
Filter grants to one or more product IDs. Provide the parameter multiple times.
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/v1/grants"{
"items": [
{
"id": "bgt_01KKSMB47VYGW97GFE67VGDK7M",
"user_id": "string",
"benefit_id": "string",
"status": "scheduled",
"starts_at": null,
"expires_at": {},
"value_initial": 0,
"value_current": 0,
"value_consumed": 0,
"parent": {
"benefit_schedule_id": "string",
"subscription_id": "string",
"product_id": "string"
},
"state_transitions": {
"started_at": {},
"expired_at": {},
"depleted_at": {},
"revoked_at": {}
},
"next_update": {
"updates_at": null,
"update_type": "starts"
},
"created_at": null,
"updated_at": null
}
],
"total": 0,
"page": 1,
"size": 1,
"pages": 0
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string",
"input": null,
"ctx": {}
}
]
}