{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/v2/submission/:id.json","auth":"required","params":[{"name":"id","type":"int","default":"","desc":"Submission ID","required":true,"in":"path","ref":"","_id":"54349b7f0ef9c00800165295"},{"name":"encryption_password","type":"string","default":"","desc":"The encryption password for the form","required":false,"in":"query","ref":"","_id":"54349b7f0ef9c00800165294"}],"results":{"codes":[{"name":"Success","status":200,"language":"json","code":"{\n  \"id\": \"1001\",\n  \"timestamp\": \"2007-01-01 01:01:01\",\n  \"user_agent\": \"Mozilla/4.0 (compatible; MSIE 7.0; Windows NT 5.1)\",\n  \"remote_addr\": \"127.0.0.1\",\n  \"form\": \"12345\",\n  \"latitude\": \"39.9143631\",\n  \"longitude\": \"-86.0761059\",\n  \"data\": [{\n    \"field\": \"1111\",\n    \"value\": \"John Smith\"\n  },{\n    \"field\": \"2222\",\n    \"value\": \"Apple\"\n  }]\n}"},{"name":"Submission ID not specified","status":400,"language":"json","code":"{\n  \"status\": \"error\",\n  \"error\": \"A submission id was not supplied\"\n}"},{"name":"Submission not found","status":404,"language":"json","code":"{\n  \"status\": \"error\",\n  \"error\": \"A valid submission id was not supplied\"\n}"},{"name":"Form not found","status":500,"language":"json","code":"{\n  \"status\": \"error\",\n  \"error\": \"A valid form could not be found\"\n}"},{"name":"Forbidden action","status":403,"language":"json","code":"{\n  \"status\": \"error\",\n  \"error\": \"The action was forbidden by form permissions\"\n}"},{"name":"Encryption password argument missing","status":400,"language":"json","code":"{\n  \"status\": \"error\",\n  \"error\": \"An encryption password was not supplied\"\n}"},{"name":"Decryption error","status":500,"language":"json","code":"{\n  \"status\": \"error\",\n  \"error\": \"An error occurred while decrypting the submission\"\n}"},{"code":"{\n  \"id\": \"1001\",\n  \"timestamp\": \"2007-01-01 01:01:01\",\n  \"user_agent\": \"Mozilla/4.0 (compatible; MSIE 7.0; Windows NT 5.1)\",\n  \"remote_addr\": \"127.0.0.1\",\n  \"form\": \"12345\",\n  \"latitude\": \"39.9143631\",\n  \"longitude\": \"-86.0761059\",\n  \"data\": [{\n    \"field\": \"1111\",\n    \"value\": \"John Smith\"\n  },{\n    \"field\": \"2222\",\n    \"value\": \"Apple\"\n  }],\n  \"approval_status\": \"Approved\"\n}","name":"Success When Form Has Approvals Enabled","status":200,"language":"json"},{"name":"Success When Submission went through portal form","status":200,"language":"json","code":"{\n  \"id\": \"1001\",\n  \"timestamp\": \"2007-01-01 01:01:01\",\n  \"user_agent\": \"Mozilla/4.0 (compatible; MSIE 7.0; Windows NT 5.1)\",\n  \"remote_addr\": \"127.0.0.1\",\n  \"form\": \"12345\",\n  \"latitude\": \"39.9143631\",\n  \"longitude\": \"-86.0761059\",\n  \"data\": [{\n    \"field\": \"1111\",\n    \"value\": \"John Smith\"\n  },{\n    \"field\": \"2222\",\n    \"value\": \"Apple\"\n  }],\n  \"portal_name\": \"Portal#1\",\n  \"portal_form_name\": \"Form\",\n  \"portal_participant_email\": \"john.smith:::at:::johnsmit.com\"\n}"}]},"try":false,"basic_auth":false,"method":"get","examples":{"codes":[]},"settings":"5e2b1ec0f26a2c00510363e5"},"next":{"description":"","pages":[]},"title":"/submission/:id","type":"endpoint","slug":"submission-id-get","excerpt":"Get the details of the specified submission","body":"Get the details of the specified submission\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"GET /api/v2/submission/12345.json HTTP/1.1\\nHost: www.formstack.com\\nAuthorization: Bearer [[app:oauth_token]]\\nAccept: application/json\\nContent-Type: application/json\",\n      \"language\": \"http\"\n    },\n    {\n      \"code\": \"curl -i -H \\\"Accept: application/json\\\" -H \\\"Content-Type: application/json\\\" -H \\\"Authorization: Bearer [[app:oauth_token]]\\\" https://www.formstack.com/api/v2/submission/12345.json\",\n      \"language\": \"shell\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"File Uploads and Signatures\"\n}\n[/block]\nFile uploads and signatures are both returned as URLs. These URLs will point towards our Formstack file location, or to the third party file upload service that you have configured on your form.","updates":[],"order":30,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"54349b7f0ef9c00800165293","project":"543469460ef9c00800164f0e","user":"543469060ef9c00800164f01","githubsync":"","editedParams":true,"createdAt":"2014-10-08T02:03:43.200Z","editedParams2":true,"is_link":false,"category":{"sync":{"isSync":false,"url":""},"pages":["5435626c5ff8a51a006e4110","543553953513400800a14736","543555cc3513400800a14752","54355bcc35740020002a1b3b","5434928b0ef9c0080016520e","54347c8e5b10711400c6c30a","54346f750ef9c00800164fa0","543470f45b10711400c6c1e5","543477b70ef9c0080016505b","543478fb5b10711400c6c29f","54347d105b10711400c6c318","54347df00ef9c008001650d2","54347edf5b10711400c6c336","54357a175e1b2020004380dc","543483520ef9c0080016512a","543484820ef9c0080016513a","5434887e5b10711400c6c3cd","543488c05b10711400c6c3d2","54348ac85b10711400c6c401","5434959c0ef9c0080016522d","543497030ef9c00800165244","543498ae5b10711400c6c4f6","54349b7f0ef9c00800165293","54349c070ef9c00800165298","54349dbf0ef9c008001652ad","5434ab8e0ef9c00800165384","5434abbb0ef9c0080016538f","5434ac495b10711400c6c626","5434ada40ef9c008001653a8","5434af0a0ef9c008001653bc","5434af5f0ef9c008001653c8","5434b00a5b10711400c6c66b","5434b0d15b10711400c6c68c","5434b1ee0ef9c00800165406","5434b26d0ef9c0080016541c","5434b3560ef9c00800165427","5434b3b40ef9c0080016545a","5434b49f008ec22200d86ab9","5434b51f008ec22200d86aca","5434b5a80ef9c0080016546f","5434b5f4008ec22200d86ad8","5434b676008ec22200d86add","5434b6e6008ec22200d86ae5"],"title":"REST API","slug":"rest-api","order":1,"from_sync":false,"reference":false,"_id":"5434918d0ef9c008001651ff","version":"54346a2a0ef9c00800164f28","__v":30,"project":"543469460ef9c00800164f0e","createdAt":"2014-10-08T01:21:17.804Z"},"parentDoc":null,"version":{"version":"2.0","version_clean":"2.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["54346a2b0ef9c00800164f29","543473445b10711400c6c21a","543473500ef9c00800164fde","54347c625b10711400c6c301","5434918d0ef9c008001651ff","5434b72c008ec22200d86ae7","5435990c495d5d0800f3a510","5b6af3dffc81e4000383db74"],"_id":"54346a2a0ef9c00800164f28","releaseDate":"2014-10-07T22:33:14.982Z","createdAt":"2014-10-07T22:33:14.982Z","forked_from":"543469460ef9c00800164f11","project":"543469460ef9c00800164f0e","__v":8},"__v":2}

get/submission/:id

Get the details of the specified submission

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
required
integer
Submission ID

Query Params

encryption_password:
string
The encryption password for the form

Result Format


Documentation

Get the details of the specified submission [block:code] { "codes": [ { "code": "GET /api/v2/submission/12345.json HTTP/1.1\nHost: www.formstack.com\nAuthorization: Bearer [[app:oauth_token]]\nAccept: application/json\nContent-Type: application/json", "language": "http" }, { "code": "curl -i -H \"Accept: application/json\" -H \"Content-Type: application/json\" -H \"Authorization: Bearer [[app:oauth_token]]\" https://www.formstack.com/api/v2/submission/12345.json", "language": "shell" } ] } [/block] [block:api-header] { "type": "basic", "title": "File Uploads and Signatures" } [/block] File uploads and signatures are both returned as URLs. These URLs will point towards our Formstack file location, or to the third party file upload service that you have configured on your form.

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}