Files

Base URL https://api.leadx.in/api/key/protected. Every request needs an apikey header — see Authentication.

5 endpoints.

GET /file

Get all file objects.

Auth apikey

:::note Used by the web app components/CustomFieldsBasedForm.jsx, components/FileUpload.jsx, pages/AddEmailTemplate.jsx and 1 more :::

Query parameters — the standard list contract: p, n, sortBy, sortOrder, searchBy, searchValue, filters, advancedFilters, ids, nids. See Pagination and Filtering.

Response — data is an array of File objects, alongside the pagination fields described in Response format. createdBy is populated, so it arrives as nested objects rather than ids.

DELETE /file

Delete file objects.

Auth apikey · Success 200

:::note Used by the web app components/CustomFieldsBasedForm.jsx, components/FileUpload.jsx, pages/AddEmailTemplate.jsx and 1 more :::

Request body — the standard bulk selection: ids, nids, selectAll. Query-string filters apply when selectAll is set.

Response — data is null; the outcome is the status code and message.

GET /file/:id

Get file object.

Auth apikey

:::note Used by the web app pages/AddMedia.jsx, pages/Leads.jsx :::

Path parameters

Name
id	Required

Response — data is one File object.

GET /file/recycle-bin

Get recycle bin files.

Auth apikey

Query parameters — the standard list contract: p, n, sortBy, sortOrder, searchBy, searchValue, filters, advancedFilters, ids, nids. See Pagination and Filtering.

Response — data is an array of File objects, alongside the pagination fields described in Response format.

DELETE /file/recycle-bin

Clear recycle bin.

Auth apikey · Success 200

Response — data is one File object. (Resource deduced from the collections this handler reads, not read off an explicit return.)