Flatfile subpackage_data-retention-policies API
The subpackage_data-retention-policies API from Flatfile — 2 operation(s) for subpackage_data-retention-policies.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/flatfile-subpackage-data-retention-policies-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Reference subpackage_accounts Subpackage Data Retention Policies API
version: 1.0.0
servers:
- url: https://api.x.flatfile.com/v1
tags:
- name: subpackage_data-retention-policies
paths:
/data-retention-policies:
get:
operationId: list
summary: List data retention policies
description: Returns all data retention policies on an account matching a filter for environmentId
tags:
- subpackage_data-retention-policies
parameters:
- name: environmentId
in: query
description: The associated Environment ID of the policy.
required: false
schema:
$ref: '#/components/schemas/type_commons_EnvironmentId'
- name: Authorization
in: header
description: Bearer authentication
required: true
schema:
type: string
- name: X-Disable-Hooks
in: header
required: true
schema:
type: string
enum:
- 'true'
responses:
'200':
description: Response with status 200
content:
application/json:
schema:
$ref: '#/components/schemas/type_data-retention-policies_ListDataRetentionPoliciesResponse'
'400':
description: Error response with status 400
content:
application/json:
schema:
$ref: '#/components/schemas/type_commons_Errors'
'404':
description: Error response with status 404
content:
application/json:
schema:
$ref: '#/components/schemas/type_commons_Errors'
post:
operationId: create
summary: Create a data retention policy
description: Add a new data retention policy to the space
tags:
- subpackage_data-retention-policies
parameters:
- name: Authorization
in: header
description: Bearer authentication
required: true
schema:
type: string
- name: X-Disable-Hooks
in: header
required: true
schema:
type: string
enum:
- 'true'
responses:
'200':
description: Response with status 200
content:
application/json:
schema:
$ref: '#/components/schemas/type_data-retention-policies_DataRetentionPolicyResponse'
'400':
description: Error response with status 400
content:
application/json:
schema:
$ref: '#/components/schemas/type_commons_Errors'
'404':
description: Error response with status 404
content:
application/json:
schema:
$ref: '#/components/schemas/type_commons_Errors'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/type_data-retention-policies_DataRetentionPolicyConfig'
/data-retention-policies/{id}:
get:
operationId: get
summary: Get a data retention policy
description: Returns a single data retention policy
tags:
- subpackage_data-retention-policies
parameters:
- name: id
in: path
description: ID of data retention policy to return
required: true
schema:
$ref: '#/components/schemas/type_commons_DataRetentionPolicyId'
- name: Authorization
in: header
description: Bearer authentication
required: true
schema:
type: string
- name: X-Disable-Hooks
in: header
required: true
schema:
type: string
enum:
- 'true'
responses:
'200':
description: Response with status 200
content:
application/json:
schema:
$ref: '#/components/schemas/type_data-retention-policies_DataRetentionPolicyResponse'
'400':
description: Error response with status 400
content:
application/json:
schema:
$ref: '#/components/schemas/type_commons_Errors'
'404':
description: Error response with status 404
content:
application/json:
schema:
$ref: '#/components/schemas/type_commons_Errors'
patch:
operationId: update
summary: Update a data retention policy
description: Updates a single data retention policy
tags:
- subpackage_data-retention-policies
parameters:
- name: id
in: path
description: ID of data retention policy to update
required: true
schema:
$ref: '#/components/schemas/type_commons_DataRetentionPolicyId'
- name: Authorization
in: header
description: Bearer authentication
required: true
schema:
type: string
- name: X-Disable-Hooks
in: header
required: true
schema:
type: string
enum:
- 'true'
responses:
'200':
description: Response with status 200
content:
application/json:
schema:
$ref: '#/components/schemas/type_data-retention-policies_DataRetentionPolicyResponse'
'400':
description: Error response with status 400
content:
application/json:
schema:
$ref: '#/components/schemas/type_commons_Errors'
'404':
description: Error response with status 404
content:
application/json:
schema:
$ref: '#/components/schemas/type_commons_Errors'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/type_data-retention-policies_DataRetentionPolicyConfig'
delete:
operationId: delete
summary: Delete a data retention policy
description: Deletes a single data retention policy
tags:
- subpackage_data-retention-policies
parameters:
- name: id
in: path
description: ID of data retention policy to delete
required: true
schema:
$ref: '#/components/schemas/type_commons_DataRetentionPolicyId'
- name: Authorization
in: header
description: Bearer authentication
required: true
schema:
type: string
- name: X-Disable-Hooks
in: header
required: true
schema:
type: string
enum:
- 'true'
responses:
'200':
description: Response with status 200
content:
application/json:
schema:
$ref: '#/components/schemas/type_commons_Success'
'400':
description: Error response with status 400
content:
application/json:
schema:
$ref: '#/components/schemas/type_commons_Errors'
'404':
description: Error response with status 404
content:
application/json:
schema:
$ref: '#/components/schemas/type_commons_Errors'
components:
schemas:
type_data-retention-policies_DataRetentionPolicy:
type: object
properties:
type:
$ref: '#/components/schemas/type_data-retention-policies_DataRetentionPolicyEnum'
period:
type: integer
environmentId:
$ref: '#/components/schemas/type_commons_EnvironmentId'
id:
$ref: '#/components/schemas/type_commons_DataRetentionPolicyId'
createdAt:
type: string
format: date-time
description: Date the policy was created
updatedAt:
type: string
format: date-time
description: Date the policy was last updated
required:
- type
- period
- environmentId
- id
- createdAt
- updatedAt
description: A data retention policy belonging to an environment
title: DataRetentionPolicy
type_commons_Errors:
type: object
properties:
errors:
type: array
items:
$ref: '#/components/schemas/type_commons_Error'
required:
- errors
title: Errors
type_data-retention-policies_DataRetentionPolicyEnum:
type: string
enum:
- lastActivity
- sinceCreated
description: The type of data retention policy on an environment
title: DataRetentionPolicyEnum
type_commons_Error:
type: object
properties:
key:
type: string
message:
type: string
required:
- message
title: Error
type_data-retention-policies_ListDataRetentionPoliciesResponse:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/type_data-retention-policies_DataRetentionPolicy'
required:
- data
title: ListDataRetentionPoliciesResponse
type_data-retention-policies_DataRetentionPolicyResponse:
type: object
properties:
data:
$ref: '#/components/schemas/type_data-retention-policies_DataRetentionPolicy'
required:
- data
title: DataRetentionPolicyResponse
type_data-retention-policies_DataRetentionPolicyConfig:
type: object
properties:
type:
$ref: '#/components/schemas/type_data-retention-policies_DataRetentionPolicyEnum'
period:
type: integer
environmentId:
$ref: '#/components/schemas/type_commons_EnvironmentId'
required:
- type
- period
- environmentId
title: DataRetentionPolicyConfig
type_commons_DataRetentionPolicyId:
type: string
description: Data Retention Policy ID
title: DataRetentionPolicyId
type_commons_Success:
type: object
properties:
data:
$ref: '#/components/schemas/type_commons_SuccessData'
description: Informs whether or not a request was successful
title: Success
type_commons_SuccessData:
type: object
properties:
success:
type: boolean
required:
- success
title: SuccessData
type_commons_EnvironmentId:
type: string
description: Environment ID
title: EnvironmentId
securitySchemes:
default:
type: http
scheme: bearer