List Benefits
Intent
Reads the available benefits as a pageable collection without changing them.
When to call it
Call this when an interface, sync, or support workflow needs to inspect benefits. Use the filters and paging controls shown below to limit the result.
Access boundary
Authorize the request with a token that carries benefits:read or benefits:write.
Successful result
A successful request returns 200. The response schema below defines the body your integration receives.
Operational notes
List benefits.
Scopes: benefits:read benefits:write
Authorizations
You can generate an Organization Access Token from your organization's settings.
Query Parameters
Filter by organization ID. The organization ID.
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"
Filter by benefit type.
custom, discord, github_repository, downloadables, license_keys, meter_credit, feature_flag, slack_shared_channel Filter by benefit IDs. The benefit ID.
Exclude benefits with these IDs. The benefit ID.
Filter by description.
Page number, defaults to 1.
Size of a page, defaults to 10. Maximum is 100.
Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign - before the criteria name to sort by descending order.
created_at, -created_at, description, -description, type, -type, user_order, -user_order Filter by metadata key-value pairs. It uses the deepObject style, e.g. ?metadata[key]=value.
Response
Successful Response
A benefit of type custom.
Use it to grant any kind of benefit that doesn't fit in the other types.
- BenefitCustom
- BenefitDiscord
- BenefitGitHubRepository
- BenefitDownloadables
- BenefitLicenseKeys
- BenefitMeterCredit
- BenefitFeatureFlag