SAsamsara
Documents

Fetch document types

Returns a list of the organization document types. The legacy version of this endpoint can be found at samsara.com/api-legacy.

<b>Rate limit:</b> 5 requests/sec (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).

To use this endpoint, select Read Documents under the Driver Workflow category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>

Submit Feedback: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.

get/fleet/document-types

Request

  • Base URL
    https://api.samsara.com
  • Auth
    HTTP bearer

Query parameters

afterstring

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.

Response

OK response.

Example response

{
  "data": [
    {
      "conditionalFieldSections": [
        {
          "conditionalFieldFirstIndex": 1,
          "conditionalFieldLastIndex": 2,
          "triggeringFieldIndex": 0,
          "triggeringFieldValue": "Yes"
        }
      ],
      "fieldTypes": [
        {
          "fieldType": "multipleChoice",
          "label": "Was there damage?",
          "multipleChoiceFieldTypeMetaData": [
            {
              "label": "Yes"
            },
            {
              "label": "No"
            }
          ],
          "requiredField": true
        },
        {
          "fieldType": "photo",
          "label": "Damage Photos",
          "requiredField": false
        },
        {
          "fieldType": "number",
          "label": "Number of vehicles impacted",
          "numberFieldTypeMetaData": {
            "numberOfDecimalPlaces": 2
          },
          "requiredField": false
        },
        {
          "fieldType": "dateTime",
          "label": "Date and time",
          "requiredField": true
        },
        {
          "fieldType": "signature",
          "label": "Sign",
          "requiredField": true,
          "signatureFieldTypeMetaData": {
            "legalText": "Legal Text"
          }
        }
      ],
      "id": "4aff772c-a7bb-45e6-8e41-6a53e34feb83",
      "name": "Accident Report",
      "orgId": 12345
    }
  ],
  "pagination": {
    "endCursor": "MjkY",
    "hasNextPage": true
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.