Step 1. View Consent History for an Agreement

GET {{apiPath}}/environments/{{envID}}/activities?filter=resources.id eq "{{agreeID}}" and (action.type eq "AGREEMENT_CONSENT.ACCEPTED")

The /environments/{{envID}}/activities endpoint can be used to return activity events for a specified environment. This request can accept SCIM filtering expressions as query parameters to fine-tune the response. For this activity, use a GET request with SCIM filtering expressions included as query parameters to focus response data on consent agreement history for a specific agreement.

Add these as query parameters in your request URL:

FilterValueDescription
resources.id eq{{agreeID}}The UUID for the agreement.
action.type eqAGREEMENT_CONSENT.ACCEPTEDThe action type that indicates agreement consent was accepted.

Below is a description of the SCIM operators used in the filters above:

  • eq (equals)

  • and (logical AND for building compound expressions in which both expressions are true.)

Learn more about query filters and SCIM operators in the GET Read Audit Activities section of the PingOne Platform API Reference documentation.

Request Params

KeyDatatypeRequiredDescription
filterstring

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring