Files

get

Authorizations

X-API-KEYstringRequired

X-BUSINESS-IDstringRequired

X-USER-IDstringRequired

Path parameters

idstringRequiredPattern: ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$

Query parameters

orderingstring · enumOptional

Which field to use when ordering the results. Prepend with '-' for descending order.

Possible values:

Responses

200Success

application/json

idstring · uuidRead-onlyRequired

createdstring · date-timeRead-onlyRequired

keystringRequired

namestring · nullableOptional

urlstring · uriRequired

thumbnail_urlstring · uriRequired

size_bytesinteger · int64 · max: 9223372036854776000Optional

size_formattedstringRead-onlyRequired

content_typestring · nullableOptional

is_publicbooleanOptional

common_keystring · nullableRead-onlyRequired

is_commonbooleanRead-onlyRequired

metadataanyOptional

get/api/files/{id}

GET /api/files/{id} HTTP/1.1
X-API-KEY: YOUR_API_KEY
X-BUSINESS-ID: YOUR_BUSINESS_ID
X-USER-ID: YOUR_USER_ID
Accept: */*

200Success

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "created": "2026-01-01T00:00:00.000Z",
  "key": "text",
  "name": "text",
  "url": "https://example.com",
  "thumbnail_url": "https://example.com",
  "size_bytes": 1,
  "size_formatted": "text",
  "content_type": "text",
  "is_public": true,
  "common_key": "text",
  "is_common": true,
  "metadata": null,
  "employee": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

delete

Authorizations

X-API-KEYstringRequired

X-BUSINESS-IDstringRequired

X-USER-IDstringRequired

Path parameters

idstringRequiredPattern: ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$

Query parameters

orderingstring · enumOptional

Which field to use when ordering the results. Prepend with '-' for descending order.

Possible values:

Responses

204

No response body

No content

delete/api/files/{id}

DELETE /api/files/{id} HTTP/1.1
X-API-KEY: YOUR_API_KEY
X-BUSINESS-ID: YOUR_BUSINESS_ID
X-USER-ID: YOUR_USER_ID
Accept: */*

204

No response body

No content