{
"opencollection": "1.0.0",
"info": {
"name": "Samsara Submissions API",
"version": "2024-11-18"
},
"request": {
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"items": [
{
"info": {
"name": "Submissions",
"type": "folder"
},
"items": [
{
"info": {
"name": "[beta] Get a List of Specified Form Submissions.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.samsara.com/form-submissions",
"params": [
{
"name": "ids",
"value": "",
"type": "query",
"description": "A comma-separated list containing up to 100 form submission IDs to filter on. Can be either a unique Samsara ID or an [external ID](https://developers.samsara.com/docs/external-ids) for the form submission."
},
{
"name": "include",
"value": "",
"type": "query",
"description": "A comma-separated list of strings indicating whether to return additional information. Valid values: `externalIds`, `fieldLabels`"
}
]
},
"docs": "Returns all form submissions data for the specified IDs. \n\n**Beta:** This endpoint is in beta and is likely to change before being broadly available. Reach out to your Samsara Representative to have Forms APIs enabled for your organization.\n\n Rate limit: 5 requests/sec (learn more about rate limits here).\n\nTo use this endpoint, select **Read Form Submissions** under the Closed Beta category when creating or edit"
},
{
"info": {
"name": "[beta] Create a Form Submission.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.samsara.com/form-submissions",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates a form submission. \n\n**Beta:** This endpoint is in beta and is likely to change before being broadly available. Reach out to your Samsara Representative to have Forms APIs enabled for your organization.\n\n Rate limit: 100 requests/min (learn more about rate limits here).\n\nTo use this endpoint, select **Write Form Submissions** under the Closed Beta category when creating or editing an API token. Rate limit: 100 requests/min (learn more about rate limits here).\n\nTo use this endpoint, select **Write Form Submissions** under the Closed Beta category when creating or editing an API t"
},
{
"info": {
"name": "[beta] Return a PDF Export for a Form Submission.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.samsara.com/form-submissions/pdf-exports",
"params": [
{
"name": "pdfId",
"value": "",
"type": "query",
"description": "ID of the form submission PDF export."
}
]
},
"docs": "Returns a PDF export for a form submission. \n\n**Beta:** This endpoint is in beta and is likely to change before being broadly available. Reach out to your Samsara Representative to have Forms APIs enabled for your organization.\n\n Rate limit: 100 requests/min (learn more about rate limits here).\n\nTo use this endpoint, select **Read Form Submissions** under the Closed Beta category when creating or editing an API "
},
{
"info": {
"name": "[beta] Create a PDF Export for a Form Submission.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.samsara.com/form-submissions/pdf-exports",
"params": [
{
"name": "id",
"value": "",
"type": "query",
"description": "ID of the form submission to create a PDF export from."
}
]
},
"docs": "Creates a PDF export for a form submission. \n\n**Beta:** This endpoint is in beta and is likely to change before being broadly available. Reach out to your Samsara Representative to have Forms APIs enabled for your organization.\n\n Rate limit: 100 requests/min (learn more about rate limits here).\n\nTo use this endpoint, select **Write Form Submissions** under the Closed Beta category when creating or editing an API"
},
{
"info": {
"name": "[beta] Get a Stream of Filtered Form Submissions.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.samsara.com/form-submissions/stream",
"params": [
{
"name": "startTime",
"value": "",
"type": "query",
"description": " A start time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00)."
},
{
"name": "endTime",
"value": "",
"type": "query",
"description": " An end time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00)."
},
{
"name": "after",
"value": "",
"type": "query",
"description": " If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results."
},
{
"name": "formTemplateIds",
"value": "",
"type": "query",
"description": "A comma-separated list containing up to 50 template IDs to filter data to."
},
{
"name": "userIds",
"value": "",
"type": "query",
"description": "A comma-separated list containing up to 50 user IDs to filter data to."
},
{
"name": "driverIds",
"value": "",
"type": "query",
"description": "A comma-separated list containing up to 50 user IDs to filter data to."
},
{
"name": "include",
"value": "",
"type": "query",
"description": "A comma-separated list of strings indicating whether to return additional information. Valid values: `externalIds`, `fieldLabels`"
}
]
},
"docs": "Returns all form submissions data that has been created or modified for your organization based on the time parameters passed in. Results are paginated and are sorted by last modified date. If you include an endTime, the endpoint will return data up until that point (exclusive). If you dont include an endTime, you can continue to poll the API real-time with the pagination cursor that gets returned on every call. \n\n**Beta:** This endpoint is in beta and is likely to change before being broadly av"
}
]
}
],
"bundled": true
}