Skip to main content
GET
List On-Ramp Sessions

Authorizations

Authorization
string
header
required

Access token obtained via /oauth2/token/. Use as Authorization: Bearer <access_token>.

Query Parameters

customerId
string<uuid>

Filter the results to the on-ramp session of a single customer, by your partner-facing customer ID.

Response

A paginated list of on-ramp sessions.

count
integer

Total number of items across all pages.

next
string<uri> | null

URL to the next page of results. Null if no next page.

previous
string<uri> | null

URL to the previous page of results. Null if no previous page.

results
object[]

Array of On-Ramp session objects for the current page.