Skip to main content
GET
Retrieve benefits

Authorizations

Authorization
string
header
required

See our authentication documentation for how to authorize your requests

Scopes

benefits.readonly

Read benefits and applications

benefits

Read and write benefits and applications

Headers

spacebring-network-id
string<uuid>

The id of the network. Required when using bearer token authentication

Query Parameters

categoryRef
string<uuid>

UUID of the benefit category.

Filter by featured status. Pass true or false.

limit
integer

Maximum number of benefits per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100.

Required range: 1 <= x <= 100
locationRef
string<uuid>

UUID of the location. Omit both locationRef and categoryRef to list benefits across every location of the network.

nextPageToken
string

Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page.

Response

OK

benefits
object[]
required

List of benefits.

nextPageToken
string

Pagination token to fetch the next page of results.

searchQueryNext
string

Search query parameters for the next page of results. Includes all filters used to fetch the current page.