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.
Authorizations
Query Parameters
Return only records matching organization ID. Identifier of the organization.
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"
Return only records matching benefit type.
custom, discord, github_repository, downloadables, license_keys, meter_credit, feature_flag, slack_shared_channel Return only records matching benefit IDs. Identifier of the benefit.
Parameter: Exclude benefits with these IDs. Identifier of the benefit.
Return only records matching description.
Results page to return. The first page is used by default.
Records returned per page. Defaults to 10 and accepts up to 100.
Sort rules applied from left to right. Prefix any rule with - to reverse it into descending order.
created_at, -created_at, description, -description, type, -type, user_order, -user_order Return only records matching metadata key-value pairs. It uses the deepObject style, e.g. ?metadata[key]=value.
Response
Request completed successfully
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