Read All Agreements

GET {{apiPath}}/environments/{{envID}}/agreements

The GET /environments/{{envID}}/agreements endpoint returns a list of all agreement resources for the specified environment resource.

**Note: Response data paging is not available at this time.

RESPONSES

status: OK

{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/agreements"}},"_embedded":{"agreements":[{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/agreements/43eb5621-eae8-4fa1-aafb-2a884d6848cb"},"environment":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"}},"id":"43eb5621-eae8-4fa1-aafb-2a884d6848cb","environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"name":"Agreement_1_UPDATED_1601679632","reconsentPeriodDays":360,"totalConsents":1,"totalExpiredConsents":0,"consentsAggregatedAt":"2021-09-22T18:02:10.911Z","enabled":true},{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/agreements/49d7aa39-41a0-4a6d-bafd-84cc5abf98f5"},"environment":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"}},"id":"49d7aa39-41a0-4a6d-bafd-84cc5abf98f5","environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"name":"Agreement_2","description":"Terms of service agreement","reconsentPeriodDays":180,"totalConsents":0,"totalExpiredConsents":0,"consentsAggregatedAt":"2021-09-22T18:02:11.020Z","enabled":false}]},"count":2,"size":2}