Skip to main content
GET
/
files
Get files
curl --request GET \
  --url https://api.sandbox.monite.com/v1/files \
  --header 'Authorization: Bearer <token>' \
  --header 'x-monite-version: <x-monite-version>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "file_type": "<string>",
      "md5": "<string>",
      "mimetype": "<string>",
      "name": "<string>",
      "region": "<string>",
      "s3_bucket": "<string>",
      "s3_file_path": "<string>",
      "size": 123,
      "url": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-monite-version
string<date>
required

Query Parameters

​
id__in
string<uuid>[] | null

Return only files with specified IDs. Valid but nonexistent IDs do not raise errors but produce no results.

To specify multiple IDs, repeat this parameter for each value: id__in=<id1>&id__in=<id2>

Maximum array length: 250
​
file_type
enum<string> | null

Return only files with the given purpose. Possible values:

  • additional_identity_documents and identity_documents - entity verification documents uploaded for payments onboarding.
  • attachments - supplementary attachments for accounts receivable invoices, quotes, and credit notes.
  • delivery_notes - auto-generated PDF versions of delivery notes.
  • einvoices_xml - e-invoice XML generated when sending e-invoices.
  • payables - payables (bills) received via email or uploaded via API.
  • receivable_signatures - images of customer signatures provided during quote acceptance.
  • receivables - auto-generated PDF versions of invoices, quotes, and credit notes.
  • zip - data export archives created by POST /data_exports.

Other values are unused.

Available options:
ocr_results,
ocr_files,
payables,
receivables,
delivery_notes,
receipts,
userpics,
entity_logo,
companies_logo,
zip,
identity_documents,
additional_identity_documents,
receivable_signatures,
einvoices_xml,
attachments

Response

Successful Response

​
data
object[]
required