Tagged Documents
Endpoints for fetching documents with the specified tags.
GET /guides
Get a list of guides with the specified tags. Every guide must match ALL requiredTags
Query Parameters
- required_tags — Required — array of strings
-
Comma separated list of tags that must be present on all guides.
- guide_type — Optional — string
-
The type of guide to return. (E.g. 'How-to', 'Repair', 'Maintenance).
- order — Optional — enum
-
Return the guides ordered by the specified field. Defaults to 'title'.
Possible Values:
- title
- release_date
- parent_category
- direction — Optional — enum
-
The direction to sort the guides. Defaults to 'asc'.
Possible Values:
- asc
- desc
- offset — Optional — integer
-
The number of guides to skip from the beginning. Defaults to 0.
- limit — Optional — integer
-
The maximum number of guides to include in the response. Range: [1, 200]. Defaults to 50.
- workspaceid — Optional — integer
-
The id of the workspace to filter guides by. If provided, only guides in this workspace will be returned.
Response
Status: 200 OK
{
"results": [
{
"id": 401,
"url": "https:\/\/www.example.com\/Guide\/Forklift+Safety\/401",
"type": "guide",
"title": "Forklift Safety",
"summary": "",
"thumbnail_url": "https:\/\/www.example.com\/static\/images\/guide\/NoImage_96x72.jpg",
"revisionid": 4322,
"release_version": "2.0",
"release_date": "2020-08-18T05:24:09Z",
"parent_category": {
"id": 263,
"title": "Safety Training - All Employees"
},
"workspace": {
"id": 599,
"title": "Sacramento"
},
"guide_type": "how-to"
},
{
"id": 219,
"url": "https:\/\/www.example.com\/Guide\/How+to+Grease+Coupling+Middle+Piece\/219",
"type": "guide",
"title": "How to Grease Coupling Middle Piece",
"summary": "",
"thumbnail_url": "https:\/\/www.example.com\/static\/images\/guide\/NoImage_96x72.jpg",
"revisionid": 12213,
"release_version": "1.0",
"release_date": "2024-03-05T17:25:44Z",
"parent_category": {
"id": 13,
"title": "Maintenance"
},
"workspace": {
"id": 599,
"title": "Sacramento"
},
"guide_type": "how-to"
},
{
"id": 56,
"url": "https:\/\/www.example.com\/Guide\/How+to+Lock+Out+-+Tag+Out+(LOTO)\/56",
"type": "guide",
"title": "How to Lock Out \/ Tag Out (LOTO)",
"summary": "This guide illustrates how to perform a Lock Out \/ Tag Out Procedure for Authorized Machine Operators..",
"thumbnail_url": "https:\/\/www.example.com\/static\/images\/guide\/NoImage_96x72.jpg",
"revisionid": 14433,
"release_version": "6.2",
"release_date": "2024-10-02T17:30:45Z",
"parent_category": {
"id": 112,
"title": "Lock Out Tag Out Procedures"
},
"workspace": {
"id": 599,
"title": "Sacramento"
},
"guide_type": "how-to"
},
{
"id": 182,
"url": "https:\/\/www.example.com\/Guide\/New+Employee+Safety+Orientation\/182",
"type": "guide",
"title": "New Employee Safety Orientation",
"summary": "",
"thumbnail_url": "https:\/\/www.example.com\/static\/images\/guide\/NoImage_96x72.jpg",
"revisionid": 2611,
"release_version": "2.0",
"release_date": "2019-11-01T22:37:03Z",
"parent_category": {
"id": 263,
"title": "Safety Training - All Employees"
},
"workspace": {
"id": 599,
"title": "Sacramento"
},
"guide_type": "how-to"
}
],
"hasMore": false
}