Skip to content

Retrieve a document

GET /api/document/{documentId}

Retrieve an existing Formbird document using its documentId

Arguments
  • your apiKey, for example: 0525a150-af9c-11e6-812e-cd6505553560
  • documentId - the document you want to retrieve
Example Request
curl http://localhost:3000/api/document/dcfc63d0-9442-11e7-a6b2-d9cc8e84f3a6 \
 -H "apiKey: 0525a150-af9c-11e6-812e-cd6505553560"
Example Response
{
    "systemHeader": {
        "templateId": "547fe84c9c1d86680d9806bd",
        "keyIds": [],
        "serverUpdatedDate": "2017-09-08T03:07:37.380Z",
        "serverCreatedDate": "2017-09-08T03:07:37.380Z",
        "versionId": "de24de40-9442-11e7-a6b2-d9cc8e84f3a6",
        "excludeGeneralSearch": false,
        "systemType": "document",
        "currentVersion": true,
        "createdDate": "2017-09-08T03:07:37.380Z",
        "createdBy": "548684a629a5e8d820b12c01",
        "summaryName": "apiTest",
        "summaryDescription": "apiTest"
    },
    "text": "apiTest",
    "documentId": "dcfc63d0-9442-11e7-a6b2-d9cc8e84f3a6"
}

The response contains the document requested