Name
Retention
How long each file type is kept before it is deleted.
HTTP method and path
/https:
What happens when you run it
- Read only: it does not change your organization’s data.
- The call is not charged.
What it does
Returns, per file type, the current retention time, the minimum and maximum it allows, the default, whether your organization chose its own and who changed it last. deletionInProgress. counts the files being deleted now. The time is changed from the customer portal: here it is only read.
Availability and prerequisites
- Published and available in the production API v6.
- Every path starts at
https:./ / developers. hablame. co - You need a Hablame API key to call it.
Authentication and permissions
- Send your API key in the
Authorizationheader with the Bearer scheme.
Who can call it: An API key with the storage service enabled.
Limits and operational notes
Usage limit: 10 requests per second.
- The six Storage queries (summary, usage, list, detail, retention and pricing) share this per-organization quota: it is not a per-endpoint quota.
Path parameters
This endpoint has no path parameters.
Query parameters
This endpoint has no query parameters.
HTTP headers
| Name | Type | Description and rules |
|---|---|---|
AuthorizationRequired | string | Your API key with the Bearer scheme. Example: |
Request body
This endpoint takes no request body.
Successful responses
200
Retention per file type.
{
"success": true,
"data": {
"items": [
{
"service": "callblasting",
"scope": "recordings",
"name": "Grabaciones",
"seconds": 2592000,
"minSeconds": 86400,
"maxSeconds": 31536000,
"defaultSeconds": 2592000,
"custom": false,
"version": 0,
"updatedBy": null,
"updatedAt": null,
"deletionInProgress": { "objects": 0 }
}
]
},
"meta": {
"requestId": "5d0f3a9c7b2e41a8",
"clientIp": "203.0.113.10",
"timestamp": "2026-10-19T15:30:00+00:00",
"responseTimeMs": 12.4
}
}The example values are illustrative.
Response fields
| Name | Type | Description and rules |
|---|---|---|
successAlways present | boolean | |
dataAlways present | object | |
data.Always present | array<object> | |
data.Always present | string | |
data.Always present | string | |
data.Always present | string | File type name, in Spanish. |
data.Always present | integer | Current retention time, in seconds. |
data.Always present | integer | |
data.Always present | integer | |
data.Always present | integer | |
data.Always present | boolean |
|
data.Always present | integer | |
data.Always present | string | Who changed it last. May come as |
data.Always present | string | May come as Format: |
data.Always present | object | |
data.Always present | integer | |
metaAlways present | object | Response metadata. |
meta.Always present | string | Unique request identifier (16 hexadecimal characters). It matches the Example: |
meta.Always present | string | IP the API saw your request come from. Useful if your API key only accepts certain networks. Example: |
meta.Always present | string | Date and time the response was built (ISO 8601 with offset). Format: |
meta.Always present | number | Time (ms) the server took to process the request. Example: |
Error codes
Every error response has the same shape: success set to false and an error object whose code says what happened. They are grouped here by kind, with the codes this endpoint can return.
Shape of an error response
| Name | Type | Description and rules |
|---|---|---|
successAlways present | boolean | Fixed value: |
metaAlways present | object | Response metadata. |
meta.Always present | string | Unique request identifier (16 hexadecimal characters). It matches the Example: |
meta.Always present | string | IP the API saw your request come from. Useful if your API key only accepts certain networks. Example: |
meta.Always present | string | Date and time the response was built (ISO 8601 with offset). Format: |
meta.Always present | number | Time (ms) the server took to process the request. Example: |
errorAlways present | object | |
error.Always present | string | Stable UPPER_SNAKE_CASE identifier. Clients branch on this value. Example: |
error. | integer | Legacy v5 numeric code, only when a bridge exists. Omitted for codes born in v6. Example: |
error.Always present | string | URL to the error documentation. Format: |
error.Always present | string | Human readable text, in English. It is for the developer log, not the end user: do not parse it. |
error.Always present | array<object> | Structured context (validation issues, affected resource). Empty array when there is no extra context. |
Validation
This endpoint does not declare responses of this kind.
Authentication
- 401Invalid or missing credentials.
No Bearer token was sent, and every call requires one.
Message the API returns: Authentication is required. Send your API key as `Authorization: Bearer <token>`.
The API key is not recognized: wrong format, revoked or expired.
Message the API returns: The provided API key is invalid or has expired. Please verify the value sent in the `Authorization: Bearer` header.
Permissions
- 403The API key does not have the Storage service (
storage), cannot be used from the request network, or the organization is not active.
The key is not allowed to use the service behind this endpoint.
Message the API returns: This API key is not authorized to use the requested service.
The key only works from certain networks and your IP is not one of them.
Message the API returns: This API key cannot be used from this IP address. The address we saw is in `meta.clientIp`: call from one of the networks allowed for the key, or use a key that allows this one.
Your organization is suspended or closed.
Message the API returns: The organization associated with this API key is not active. Please contact support.
Usage limits
- 429Request limit exceeded.
You exceeded your organization quota for this endpoint.
Message the API returns: You have exceeded the allowed request rate for this endpoint. Please wait before retrying.
Resource not found
This endpoint does not declare responses of this kind.
Internal errors and availability
- 503Storage is not responding right now. Retry after
Retry-After.
Generic 503: a service we depend on is not responding.
Other responses
This endpoint does not declare responses of this kind.
Special considerations
Read-only; storage never pauses
Your files are stored continuously and never pause, even without balance. To query them over the API, the API key needs the Storage service (storage): with it, the key sees everything (summary, usage, files, downloads, retention and pricing), and without it each of these endpoints answers 403 AUTH_SERVICE_NOT_ALLOWED. The API is read-only: the retention time is changed from the customer portal (Storage → Retention) and a file is deleted there or when it expires. Any method other than GET answers 405.