Skip to main content
GET
Retrieve applications

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

benefitRef
string<uuid>

UUID of the benefit.

categoryRef
string

Filter by the category of the benefit applied for: the IDs of benefit categories, or none for benefits without a category. Comma-separated, one or more UUIDs or "none".

createDate[gte]
string

Filter applications submitted on or after this date (ISO 8601). Use with createDate[lte] for a range.

createDate[lte]
string

Filter applications submitted on or before this date (ISO 8601). Use with createDate[gte] for a range.

customerRef
string<uuid>

UUID of the customer whose applications to list.

limit
integer

Maximum number of applications 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 locationRef, benefitRef, customerRef and userRef to list applications 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.

userRef
string<uuid>

UUID of the user whose applications to list.

Response

OK

applications
object[]
required

List of benefit applications.

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.