List files
Request, parameters, response and errors of GET /v1/files.
Last updated:
Returns the metadata of the files attached to the properties of the office, newest first by default. Filter by listingId. A file has no time of change, so updatedSince is rejected as an unknown parameter; follow new files with sort=-createdAt and stop at the last createdAt you saw. Needs read access to files.
Requires the scope read and at least the level read on files.
Request
GET https://api.athaus.ai/v1/filesParameters
Query
| Name | Type | Required | Description |
|---|---|---|---|
limit | integer | no | Page size, 1 to 100. More than 100 is rejected, never capped. Default 50. |
cursor | string | no | Opaque value from nextCursor of the previous page. |
listingId | string (uuid) | no | Only files of this property. |
sort | string | no | Field to order by. A leading - sorts descending. One of createdAt, -createdAt. Default -createdAt. |
Header
| Name | Type | Required | Description |
|---|---|---|---|
Athaus-Version | string | no | Optional and carries nothing a client needs: the version is the path. Accepted when it says v1 or 1. Any other value is a 400 api_version_unsupported. |
Example
curl "https://api.athaus.ai/v1/files?limit=10" \
-H "Authorization: Bearer ath_live_..."Response
On success the status is 200 with FileList.
FileList
| Field | Type | Description |
|---|---|---|
object | string | Always list. |
data | File[] | |
hasMore | boolean | True if another page follows. |
nextCursor | string | null | Pass as cursor to get the next page. Null on the last page. |
File
| Field | Type | Description |
|---|---|---|
object | string | Always file. |
id | string | UUID of the file. |
listingId | string | |
kind | string | One of photo, floor_plan, document. |
documentType | string | null | For a document, which paper it is, in the keys the app uses. Null if it was not sorted. |
filename | string | null | |
mimeType | string | null | |
sizeBytes | integer | null | |
width | integer | null | In pixels, for an image where it is known. |
height | integer | null | In pixels, for an image where it is known. |
caption | string | null | |
position | integer | The order within the property. Position 0 is the cover. |
createdAt | string (date-time) |
Response headers
| Header | Description |
|---|---|
Request-Id | Identifies this request. Quote it in a support request. |
Athaus-Version | The API version of this response: v1. |
Athaus-Release | The release of v1 that answered, for example 1.0. A label for support and changelogs; no request can select it. |
RateLimit-Policy | The quota policy of the bucket that applies. |
RateLimit | Remaining quota and seconds until the bucket is full again. |
Errors
Every error arrives as problem details. Branch on code, not on title or detail.
| Status | Codes | Meaning |
|---|---|---|
400 | invalid_query, api_version_unsupported | Invalid request. |
401 | unauthorized | Missing or invalid API key. |
403 | insufficient_permissions, plan_required | The key lacks a right, or the plan does not include API access. |
404 | not_found | Nothing under this ID. |
429 | rate_limited | Rate limit exceeded. |
500 | internal_error | Server error. |
Keep reading
REST API: authentication with an API key
Every call to /v1 carries an API key as a bearer token. Where to get one, which scopes it carries and what does not work.
REST API: errors as problem details
Every error from /v1 is an RFC 9457 problem with a real HTTP status, a code to branch on and a request id for support.