YAyapily
Consents

Get Consents

Used to retrieve all the consents created for each user within an application. At least one of the following filters needs to be applied: filter[applicationUserId], filter[userUuid]=, limit=.

get/consents

Request

  • Base URL
    https://api.yapily.com
  • Auth
    HTTP basic

Query parameters

filter[applicationUserId]string[]

Optional. Filter records based on the list of applicationUserId users provided. At least one of these filters filter[applicationUserId], filter[userUuid]=, limit= must be provided.

filter[userUuid]string[]

Optional. Filter records based on the list of userUuid users provided. At least one of these filters filter[applicationUserId], filter[userUuid]=, limit= must be provided.

filter[institution]string[]

Optional. Filter records based on the list of Institution provided.

filter[status]string[]

Optional. Filter records based on the list of Consent statuses.

fromstring

Optional. Returned transactions will be on or after this date (yyyy-MM-dd'T'HH:mm:ss.SSSZ).

beforestring

Optional. Returned transactions will be on or before this date (yyyy-MM-dd'T'HH:mm:ss.SSSZ).

limitinteger

Optional. The maximum number of transaction records to be returned. Must be between 1 and 1000. At least one of these filters filter[applicationUserId], filter[userUuid]=, limit= must be provided.

offsetinteger

Optional. The number of transaction records to be skipped. Used primarily with paginated results.

Response

Ok

linksobject
tracingIdstring

Changes

No recorded changes to this operation across all 4 revisions of this API.