List Benefits

List benefits.

Scopes: benefits:read benefits:write

GET /v1/benefits

List Benefits

cURL

curl --request GET \
  --url https://api.spairehq.com/v1/benefits/ \
  --header 'Authorization: Bearer <token>'

200

{
  "items": [
    {
      "id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z",
      "type": "<string>",
      "description": "<string>",
      "selectable": true,
      "deletable": true,
      "organization_id": "<string>",
      "metadata": {},
      "properties": {
        "note": "<string>"
      }
    }
  ],
  "pagination": {
    "total_count": 123,
    "max_page": 123
  }
}

Authorizations

patoat

Authorization · string · header · required

You can generate a Personal Access Token from your settings.

Query Parameters

organization_id · string<uuid4> string<uuid4>[]

Filter by organization ID. The organization ID.

Example:

"1dbfc517-0bbf-4301-9ba8-555ca42b9737"

type · enum<string> enum<string>[]

Filter by benefit type.

Available options: custom, discord, github_repository, downloadables, license_keys, meter_credit, course_access

id · string<uuid4> string<uuid4>[]

Filter by benefit IDs. The benefit ID.

exclude_id · string<uuid4> string<uuid4>[]

Exclude benefits with these IDs. The benefit ID.

query · string | null

Filter by description.

page · integer · default: 1

Page number, defaults to 1.

limit · integer · default: 10

Size of a page, defaults to 10. Maximum is 100.

sorting · enum<string>[] | null

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.

Available options: created_at, -created_at, description, -description, type, -type, user_order, -user_order

metadata · MetadataQuery · object

Filter by metadata key-value pairs. It uses the deepObject style, e.g. ?metadata[key]=value.

Show child attributes

Response

200

application/json

Successful Response

items · (BenefitCustom · object | BenefitDiscord · object | BenefitGitHubRepository · object | BenefitDownloadables · object | BenefitLicenseKeys · object | BenefitMeterCredit · object | BenefitCourseAccess · object)[] · required

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

BenefitCourseAccess

Show child attributes

pagination · Pagination · object · required

Show child attributes