Data Retention Policies

List data retention policies

GET
Returns all data retention policies on an account matching a filter for environmentId

Query parameters

environmentIdstringOptional
The associated Environment ID of the policy.

Response

This endpoint returns an object
data
list of objects
A data retention policy belonging to an environment

Errors

GET
$curl -G https://api.x.flatfile.com/v1/data-retention-policies \
>     -H "Authorization: Bearer <token>" \
>     -d environmentId=us_env_YOUR_ID
Response
1{
2  "data": [
3    {
4      "createdAt": "2023-11-15T19:31:33.015Z",
5      "environmentId": "us_env_YOUR_ID",
6      "id": "us_drp_YOUR_ID",
7      "period": 5,
8      "type": "lastActivity",
9      "updatedAt": "2023-11-15T19:31:33.015Z"
10    }
11  ]
12}
Built with