Archive API

The Archive API lets your own systems store documents in the Archive and read them back: upload a file, search, download, delete and roll back. Documents you store this way appear in the Archive screen like any other.

The interactive reference, with every field and example response, is at https://archive.metaforce.net/documentation-api. You can open it without signing in.

Before you start

1. Register an API client of the type Standard under Integration then API Clients in the administration, and get a token as described in Authentication. Ask for the api.external scope.
2. Send the token on every call as Authorization: Bearer <token>.
3. The API host is api.archive.metaforce.net. Use it with https:// in front.
4. Create the folders you want to store documents in, see Access, retention and audit.

An API client acts for the whole company, so access groups do not limit it. Your company needs the Archive licence.

Choose the environment

Each Doc Gen environment has its own documents. Name the one you want in the x-centerpoint-environment header, or put it in the address after Archive, for example /Archive/Test. The names are Development, Test, PreProduction and Production, written exactly like that: test is not recognised. A call without a name, or with a name the API does not know, uses Development.

Upload a document

Send a POST to /Archive. The file goes in fileContent as base64 text.

curl -X POST "https://api.archive.metaforce.net/Archive" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-H "x-centerpoint-environment: Development" \
-H "Content-Type: application/json" \
-d '{
  "fileName": "Invoice 4711.pdf",
  "fileContent": "JVBERi0xLjQK...",
  "folderPath": "/Invoices",
  "search1": "C-1001",
  "search2": "INV-2026-0411",
  "type": 0
}'

The answer has the id of the stored document:

{
"storedDocumentId": "6abd67258a668da4ba39cbef",
"rootDocumentId": null,
"version": 0
}

If no folder matches folderPath, or neither field is given, the API answers 400 with no body and stores nothing. An unknown folderId is answered with an error too. The answer to a folder lookup is kept for up to five minutes, so create the folder before you send the first document to it.

Note: Leave id empty. Storing a new version of an existing document by sending its id does not work at the moment. The API answers with an error and no version is created.

Search for documents

Send a POST to /Archive/GetAllDocuments. Every field is optional.

curl -X POST "https://api.archive.metaforce.net/Archive/GetAllDocuments" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
  "searchQuery": "Andersson",
  "createdFrom": "2026-01-01T00:00:00",
  "createdTo": "2026-12-31T23:59:59",
  "foldersIds": ["FOLDER_ID"]
}'

• searchQuery works as Search query does in the screen, see Search and download documents.
• createdFrom and createdTo limit the result to documents stored between these two times.
• foldersIds limits the result to these folders. Put null in the list to include documents that are not in a folder.

The answer is a list of documents, newest first. Each one has its id, fileName, folderId, folderPath, type, version, the dates, search1 to search10, and a documentVersions list.

To read the company’s column settings and the folders, send a GET to /Archive/GetCompanyMetaDataColumns. The answer has the two lists colunms and folders. The first property is spelled as shown.

Download a document

Send a GET to /Archive/{id} with the id of the document. The file comes back with its own name and type. The API answers 404 when the document does not exist.

curl "https://api.archive.metaforce.net/Archive/DOCUMENT_ID" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-o invoice.pdf

Delete a document

Send a DELETE to /Archive/{id}. With the id of the document, the document and all its versions are removed. With the id of one version, only that version is removed. The API answers 200, also when there was nothing with that id.

Roll back to an earlier version

Send a POST to /Archive/Rollback. sourceFileVersionId is the id of the document and targetFileId is the id of the version to keep. All versions newer than that one are deleted. The API answers 200, or 400 when the version is not found.

curl -X POST "https://api.archive.metaforce.net/Archive/Rollback" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
  "sourceFileVersionId": "DOCUMENT_ID",
  "targetFileId": "VERSION_ID"
}'

Webhook call

Webhooks are managed under Integration then Digital Archive in the administration. Webhooks is the first tab.

To add a webhook, click New, give it a Name and a Webhook Endpoint, keep Is Active on, and click Ok. The panel is called Editing. The list shows each webhook with a Status of Active or Deactivated, its Name, its Url and when it was Created.

To change a webhook, click its Name, Url or Created in the list. The Editing panel opens with the same fields. Switch Is Active off to stop calls without losing the webhook, which then shows Deactivated, and click Ok.

To delete webhooks, tick them in the list and click Delete. The dialog Delete Webhooks Definitions asks “Are you sure you want to delete the selected webhooks definitions?”. Click Delete to confirm.

When you store a document with a callbackPayload, the Archive sends a POST to every active webhook of your company, during the upload:

{
"ActionType": 0,
"RequestPayload": "the text you sent in callbackPayload",
"DocumentId": "6abd67258a668da4ba39cbef",
"RootDocumentId": null
}

ActionType 0 means that a document was stored. If your endpoint fails or does not answer, the Archive ignores it and does not try again.

Details