--- title: "[beta] Get a stream of filtered qualification records." method: GET path: "/qualification-records/stream" tags: ["Beta APIs"] --- # \[beta\] Get a stream of filtered qualification records. `GET /qualification-records/stream` ## Request - Base URL: `https://api.samsara.com` - URL: `https://api.samsara.com/qualification-records/stream` - Auth: HTTP bearer Returns all qualification records that have 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 don't include an endTime, the API will continue to poll with the pagination cursor that gets returned on every call. The hasNextPage response value will be true if there is no endTime specified and endCursor is nonempty. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Qualification Records** under the Qualification Records category when creating or editing an API token. Learn More. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. ## Query parameters - `entityType` 'worker' | 'asset', required - `startTime` string, date-time, required - `endTime` string, date-time - `after` string - `qualificationTypeIds` string[] - `ownerIds` string[] - `includeDeleted` boolean - `includeExternalIds` boolean ## Response `200` OK response. - QualificationsGetQualificationRecordsStreamResponseBody - `data` QualificationRecordResponseObjectResponseBody[], required: List of qualification records. - `createdAtTime` string, date-time, required: Creation time. UTC timestamp in RFC 3339 format. - `createdBy` FormsPolymorphicUserObjectResponseBody, required: User or driver object. - `id` string, required: ID of the polymorphic user. - `type` 'driver' | 'user', required: The type of the polymorphic user. Valid values: `driver`, `user` - `expirationDate` string, date-time: Expiration date. UTC timestamp in RFC 3339 format. - `externalIds` object: A map of external ids - `fields` QualificationFieldInputObjectResponseBody[], required: List of field inputs in a qualification record. - `checkBoxesValue` FormsCheckBoxesValueObjectResponseBody: The value of a check boxes form input field. - `value` string[], required: List of selected options. - `valueIds` string[], required: List of selected option IDs. - `dateTimeValue` FormsDateTimeValueObjectResponseBody: The value of a datetime form input field. - `dateValue` string, date: Calendar date in YYYY-MM-DD format in the stored field timezone. Present when type is `date` (date-only fields). - `type` 'datetime' | 'date' | 'time', required: The type of datetime format. Valid values: `datetime`, `date`, `time` - `value` string, date-time, required: UTC timestamp in RFC 3339 format. - `id` string, uuid, required: ID of the qualification input field object. - `label` string: Qualification input field label. - `mediaList` FormsMediaRecordObjectResponseBody[]: List of qualification media record objects. - `id` string, uuid, required: ID of the media record. - `processingStatus` 'unknown' | 'processing' | 'finished', required: Status of the media record. Valid values: `unknown`, `processing`, `finished` - `url` string, uri: URL containing a link to associated media content. Included if 'processingStatus' is 'finished'. - `urlExpiresAt` string, date-time: Expiration time of the media record 'url'. UTC timestamp in RFC 3339 format. - `multipleChoiceValue` FormsMultipleChoiceValueObjectResponseBody: The value of a multiple choice form input field. - `value` string, required: Selected option. - `valueId` string, required: ID of the selected option. - `numberValue` FormsNumberValueObjectResponseBody: The value of a number form input field. - `value` number, double, required: Number value. - `signatureValue` FormsSignatureValueObjectResponseBody: The value of a signature form input field. - `media` FormsMediaRecordObjectResponseBody, required: Forms media record object. - `id` string, uuid, required: ID of the media record. - `processingStatus` 'unknown' | 'processing' | 'finished', required: Status of the media record. Valid values: `unknown`, `processing`, `finished` - `url` string, uri: URL containing a link to associated media content. Included if 'processingStatus' is 'finished'. - `urlExpiresAt` string, date-time: Expiration time of the media record 'url'. UTC timestamp in RFC 3339 format. - `tableValue` FormsTableValueObjectResponseBody: The value of a table form input field. - `columns` FormsTableColumnObjectResponseBody[], required: List of table columns. - `id` string, uuid, required: Unique identifier for the column. - `label` string, required: Label of the column. - `type` 'text' | 'number' | 'datetime' | 'check_boxes' | 'multiple_choice' | 'signature' | 'media' | 'person' | 'barcode', required: Type of the column field. Valid values: `text`, `number`, `datetime`, `check_boxes`, `multiple_choice`, `signature`, `media`, `person`, `barcode` - `rows` FormsTableRowObjectResponseBody[], required: List of table rows. - `cells` FormsTableCellObjectResponseBody[], required: List of cells in the row. - `barcodeValue` FormsBarcodeValueObjectResponseBody: The value of a barcode form input field. - … - `checkBoxesValue` FormsCheckBoxesValueObjectResponseBody: The value of a check boxes form input field. - … - `dateTimeValue` FormsDateTimeValueObjectResponseBody: The value of a datetime form input field. - … - `id` string, uuid, required: Unique identifier for the cell. - `mediaValue` FormsMediaValueObjectResponseBody: The value of a media form input field. - … - `multipleChoiceValue` FormsMultipleChoiceValueObjectResponseBody: The value of a multiple choice form input field. - … - `numberValue` FormsNumberValueObjectResponseBody: The value of a number form input field. - … - `personValue` FormsPersonValueObjectResponseBody: The value of a person form input field. - … - `signatureValue` FormsSignatureValueObjectResponseBody: The value of a signature form input field. - … - `textValue` FormsTextValueObjectResponseBody: The value of a text form input field. - … - `type` 'number' | 'text' | 'multiple_choice' | 'check_boxes' | 'datetime' | 'signature' | 'media' | 'person' | 'barcode', required: Type of the cell field. Valid values: `number`, `text`, `multiple_choice`, `check_boxes`, `datetime`, `signature`, `media`, `person`, `barcode` - `id` string, uuid, required: Unique identifier for the row. - `textValue` FormsTextValueObjectResponseBody: The value of a text form input field. - `value` string, required: Text value. - `type` 'number' | 'text' | 'multiple_choice' | 'check_boxes' | 'datetime' | 'signature' | 'media' | 'table', required: Type of the qualification field. Valid values: `number`, `text`, `multiple_choice`, `check_boxes`, `datetime`, `signature`, `media`, `table` - `id` string, required: ID of the qualification record. - `issueDate` string, date-time, required: Issue/effective date. UTC timestamp in RFC 3339 format. - `owner` QualificationOwnerObjectResponseBody, required: Owner of the qualification record. - `entityType` 'worker' | 'asset', required: Owner entity type Valid values: `worker`, `asset` - `externalIds` object: A map of external ids - `id` string, required: ID of the owner (worker/asset) - `qualificationType` QualificationTypeReferenceObjectResponseBody, required: Qualification type (form template) reference. - `id` string, uuid, required: ID of the qualification type (template UUID) - `name` string: Name of the qualification type - `revisionId` string, uuid: ID of the qualification type revision (template revision UUID) - `recordStatus` 'active' | 'archived' | 'deleted', required: Status of the qualification record. Valid values: `active`, `archived`, `deleted` - `updatedAtTime` string, date-time, required: Last updated time. UTC timestamp in RFC 3339 format. - `updatedBy` FormsPolymorphicUserObjectResponseBody, required: User or driver object. - `id` string, required: ID of the polymorphic user. - `type` 'driver' | 'user', required: The type of the polymorphic user. Valid values: `driver`, `user` - `pagination` GoaPaginationResponseResponseBody, required: Pagination parameters. - `endCursor` string, required: Cursor identifier representing the last element in the response. This value should be used in conjunction with a subsequent request's 'after' query parameter. This may be an empty string if there are no more pages left to view. - `hasNextPage` boolean, required: True if there are more pages of results immediately available after this endCursor. ## Other responses - `401`: Unauthorized response. - `404`: Not Found response. - `405`: Method Not Allowed response. - `413`: Content Too Large response. - `429`: Too Many Requests response. - `500`: Internal Server Error response. - `501`: Not Implemented response. - `502`: Bad Gateway response. - `503`: Service Unavailable response. - `504`: Gateway Timeout response. - `default`: Bad Request response. --- [API](https://skmtc.dev/samsara/apis/samsara-api.md) - [All operations](https://skmtc.dev/samsara/apis/samsara-api/llms.txt) - [OpenAPI document](https://skmtc.dev/samsara/apis/samsara-api/revisions/a9e35d4999be?raw)