Retrieve list of consents.

GET {{baseUrl}}/consents/v1?consentStatus=active&limit=10

Request Params

KeyDatatypeRequiredDescription
consentStatusstringOptional filter to get consents with a particular status.
configurationNamestringOptional filter to get consents only for a particular configuration name for the client.
providerIdnumberOptional filter to get consents only for a particular provider id.
offsetnumberNumber of consents to skip
limitnumberMaximum number of consents in the response
customerReferencestringOptional filter to get consents that match the customer reference exactly.
fromstringOptional filter to get consents which have been created/updated after the from date.
tostringOptional filter to get consents which have been created/updated before the to date.

RESPONSES

status: OK

[{"consentId":"urn:uuid:2c8a9ef9-9733-8380-3628-a12e151d79ba","applicationId":"urn:uuid:7c5548d4-dbd7-13fd-097a-9bb1c8b969b6","providerId":90155890,"providerName":"s","configurationName":"ex cillum Excepteur consequat","customerReference":"eu in","consentDurationType":"Single","consentStatus":"Revoked","consentStart":"1973-05-23T08:47:45.976Z","consentEnd":"1945-12-21T10:46:49.125Z","duration":"dolore ipsum enim","daysOfHistoricalTransactions":-18861994,"statusUpdated":"1974-11-25T03:15:14.406Z","statusDetails":"laboris anim magna","permissions":["id Lorem ullamco fugiat ex","minim ipsum"]},{"consentId":"009338f0-f69f-3348-81ef-3f027ab59988","applicationId":"42f52035-3a1f-7df6-b439-37932c010906","providerId":-1265128,"providerName":"non","configurationName":"consectetur esse","customerReference":"aliqua consequat est a","consentDurationType":"Single","consentStatus":"Expired","consentStart":"2002-12-24T02:14:48.156Z","consentEnd":"2008-11-29T06:19:51.643Z","duration":"nulla occaecat culpa laboris","daysOfHistoricalTransactions":9606745,"statusUpdated":"1982-12-30T07:50:03.371Z","statusDetails":"qui irure","permissions":["eu ven","sunt in"]}]