Retirements

Search retirements

Searches for all retirements for given program and/or between given date range

post/retirements/account/{AccountIdentifier}/action/search

Request

Base URL
https://sandbox.preprod.connect.xpansiv.com/app/api/v1
Auth
HTTP bearer
TypeScript
https://skmtc.dev/xpansiv/apis/xpansiv-connect-api/docs/retirements/account/:AccountIdentifier/action/search/post.ts
A function with typed inputs. Its response is checked against the schema.

AccountIdentifierstring required

Account identifier

includestring

Comma-separated values from optional response fields

programstring

Ref.Data.PROGRAM

lastUpdatedDateFromstring date-time

lastUpdatedDateTostring date-time

externalIdentifierstring

Retirements

No recorded changes to this operation across all 1 revision of this API.