Skip to content

List a cardholder's address history

GET/v1/cardholders/{id}/addresses/{kind}/history

Requires an API client bearer token.

Every address of this kind the cardholder has had, newest first — the first entry is the current one. Cursor-paginated (pass the last row's id as starting_after).

Parameters

Path parameters

NameRequiredDescription
idrequired
kindrequired

Query parameters

NameRequiredDescription
limitoptional
starting_afteroptional

Example

curl https://api.rigid.fi/v1/cardholders/{id}/addresses/{kind}/history \
  -H "Authorization: Bearer $RIGID_API_TOKEN"

Responses

200

A page of addresses, newest first.

dataarray of objectrequired
+ show properties
idstring (uuid)required
cardholder_idstring (uuid)required
kind"billing" | "delivery"required
streetstringrequired
building_numberstring | nullrequired
line2string | nullrequired
postal_codestring | nullrequired
citystringrequired
regionstring | nullrequired
countrystringrequired
created_atstringrequired

When this address was set. For the current address: on file since.

has_morebooleanrequired
next_cursorstring (uuid) | nullrequired
400

Validation error

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
401

Authentication required

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
403

Forbidden

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
404

Cardholder not found

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
500

Internal server error

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring