{"_id":"54349b7f0ef9c00800165293","project":"543469460ef9c00800164f0e","user":"543469060ef9c00800164f01","editedParams":true,"editedParams2":true,"is_link":false,"category":{"_id":"5434918d0ef9c008001651ff","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"],"version":"54346a2a0ef9c00800164f28","__v":30,"project":"543469460ef9c00800164f0e","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2014-10-08T01:21:17.804Z","from_sync":false,"order":1,"slug":"rest-api","title":"REST API"},"parentDoc":null,"version":{"_id":"54346a2a0ef9c00800164f28","forked_from":"543469460ef9c00800164f11","project":"543469460ef9c00800164f0e","__v":7,"createdAt":"2014-10-07T22:33:14.982Z","releaseDate":"2014-10-07T22:33:14.982Z","categories":["54346a2b0ef9c00800164f29","543473445b10711400c6c21a","543473500ef9c00800164fde","54347c625b10711400c6c301","5434918d0ef9c008001651ff","5434b72c008ec22200d86ae7","5435990c495d5d0800f3a510"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2.0"},"__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2014-10-08T02:03:43.200Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"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}","language":"json","status":200,"name":"Success"},{"code":"{\n  \"status\": \"error\",\n  \"error\": \"A submission id was not supplied\"\n}","language":"json","status":400,"name":"Submission ID not specified"},{"code":"{\n  \"status\": \"error\",\n  \"error\": \"A valid submission id was not supplied\"\n}","language":"json","status":404,"name":"Submission not found"},{"code":"{\n  \"status\": \"error\",\n  \"error\": \"A valid form could not be found\"\n}","language":"json","status":500,"name":"Form not found"},{"code":"{\n  \"status\": \"error\",\n  \"error\": \"The action was forbidden by form permissions\"\n}","language":"json","status":403,"name":"Forbidden action"},{"code":"{\n  \"status\": \"error\",\n  \"error\": \"An encryption password was not supplied\"\n}","language":"json","status":400,"name":"Encryption password argument missing"},{"code":"{\n  \"status\": \"error\",\n  \"error\": \"An error occurred while decrypting the submission\"\n}","language":"json","status":500,"name":"Decryption error"},{"language":"json","status":200,"name":"Success When Form Has Approvals Enabled","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}"}]},"try":false,"basic_auth":false,"method":"get","auth":"required","params":[{"_id":"54349b7f0ef9c00800165295","ref":"","in":"path","required":true,"desc":"Submission ID","default":"","type":"int","name":"id"},{"_id":"54349b7f0ef9c00800165294","ref":"","in":"query","required":false,"desc":"The encryption password for the form","default":"","type":"string","name":"encryption_password"}],"url":"/v2/submission/:id.json"},"isReference":false,"order":28,"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.","excerpt":"Get the details of the specified submission","slug":"submission-id-get","type":"endpoint","title":"/submission/:id"}

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 }}