Skip to content

View transfer history

Request

Retrieve the transfer history of the specified account.

Security
SessionKey(Required scopes: customeradministrator)
Path
numberstringrequired

Alphanumeric identifier of the user account

Query
recordsinteger

The number of records per page that should be returned

Default:25
pageinteger

The number of the results page to return

Default:1
rolestringrequired

Determines whether to return transfers for which the account holder is the sender or the recipient

Enum:"sender""recipient"
statusstring

If set, only returns transfers currently in the specified status

Enum:"Pending""Claimed""Cancelled"
curl -i -X GET \
  'https://docs.ticketingevents.com/_mock/openapi/accounts/{number}/transfers?records=25&page=1&role=sender&status=Pending' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

The list of matching transfers was successfully retrieved.

Bodyapplication/json
totalinteger

The total number of results available

pageinteger

The number of the results page returned

recordsinteger

The maximum number of results returned per page

entriesArray of objects(response-10)

List of transfers matching the given criteria

Response
{
  "page": 2,
  "records": 8,
  "entries": [
    { … }
  ]
}