Skip to content

Help Center

API Reference

Our API provides read-only access to a user’s account via simple HTTP requests. It is intended to allow individuals or organisations to export documents as a backup or to transfer to other document management platforms.

Authentication

Simul’s authentication tokens must be included as a request header in every request.

X-Simul-Token

To generate an API key, please refer to the instructions here.


User

To test your API key, call our /users/me method to get your user account details:

GET

https://app.simuldocs.com/api/users/me

Response

200 – Success

{
    username: 'info@simuldocs.com',
    displayname: 'Simul Documents'
}       

401 – Unauthorized Invalid or non-existant X-Simul-Token


Documents

Description

Gets all the documents a user has access to

GET

https://app.simuldocs.com/api/documents

Response

200 – Success

[{
    documentId: 'azm3wnd788800',
    filename: 'An example.docx',
    archived: false,
    collection: 'Examples'
}]
            

401 – Unauthorized Invalid or non-existant X-Simul-Token

Description

Gets all the versions associated with a document

GET

https://app.simuldocs.com/api/documents/:documentId/version

Response

200 – Success

[{
    revisionId: 'azm4wnd288802',
    created: 1511454358873,
    createdBy: 'info@simuldocs.com'
    label: 'Revision name'
    status: 'REVISION'|'MINOR'|'MAJOR'
}]
                

401 – Unauthorized Invalid or non-existant X-Simul-Token


Versions

Description

Downloads the Microsoft Word document for the specified version

GET

https://app.simuldocs.com/api/versions/:revisionId/contents

Response

200 – SuccessBinary file
401 – Unauthorized – Invalid or non-existant X-Simul-Token

Can't find the answer you need? Contact us!

Our team are available to answer any questions you have

Support Images