Skip to main content
GET
List recoveries
Your recoveries in this credential’s mode, newest first. Keep passing the cursor from each page until has_more is false.

Authorizations

Authorization
string
header
required

A platform access token. Get one on the Create an access token endpoint by exchanging your client_id + client_secret, then send it as Authorization: Bearer <token>. Tokens live one hour.

Query Parameters

limit
integer
default:25

Rows per page, 1 to 100. Defaults to 25.

Required range: 1 <= x <= 100
cursor
string

The cursor from the previous page.

user_id
string

Only this user's recoveries.

status
enum<string>

Only recoveries in this status.

Available options:
requested,
processing,
completed,
rejected

Response

One page of recoveries.

object
enum<string>
required

Always list.

Available options:
list
data
object[]
required
cursor
string | null
required

Pass it as cursor to read the next page. Null on the last page.

has_more
boolean
required

Whether another page follows.