API Documentation — myQA.team

SnapReport

GET/api/v1/standards

Reference endpoints for discovering the standard_id UUIDs and clause IDs needed when calling SnapReport. Any valid API key may call them.

Authentication

Any valid API key for your organization. No specific permission is required. See Authentication.

Available standards

These are the standards currently available on the platform. Use the code column anywhere an endpoint accepts a :standardId — no UUID required.

Code	Name	Version	Grading scheme
`BRCGS`	BRCGS Food Safety	Issue 9	BRC
`IFS-FOOD`	IFS Food	8	IFS
`ISO9001`	ISO 9001	2015	ISO

Call GET /api/v1/standards to always get the live list in case new standards are added.

GET

/api/v1/standards

List every standard available. Returns id, code, name, version and grading scheme. The id is what you pass as standard_id when calling analyze, but you never need to hard-code it — just call this endpoint once and look it up by code.

Use ?code= to filter to a specific standard without needing its UUID:

1# List all standards
2curl https://api.myqateam.com/api/v1/standards \
3  -H "Authorization: Bearer myqa_..."
4
5# Filter to a specific standard by code (no UUID needed)
6curl "https://api.myqateam.com/api/v1/standards?code=IFS-FOOD" \
7  -H "Authorization: Bearer myqa_..."

Response

json

1{
2  "success": true,
3  "data": [
4    {
5      "id": "5e6f1c2c-7e7a-4d62-9d7e-1234567890ab",
6      "code": "ISO 9001",
7      "name": "ISO 9001:2015",
8      "version": "2015",
9      "description": "Quality management systems — Requirements",
10      "default_language": "en",
11      "total_requirements": 132,
12      "grading_scheme": "ISO"
13    }
14  ]
15}

Use the id field as standard_id when calling POST /api/v1/snapreport/analyze.

GET

/api/v1/standards/:standardId/clauses

Return the chapter / section / clause tree for one standard. You can use the standard's code (e.g. IFS-FOOD) instead of its UUID \u2014 no need to store IDs.

Add ?chapter=<number> to get only the clauses for a specific chapter (e.g. ?chapter=1). Useful for consulting or for building a mapping table without fetching everything at once.

chapters are the top-level groupings — pass any subset of chapters[].id as the processes array of an analyze request to scope grading. Omit processes to grade against every chapter.
sections group clauses inside a chapter. Informational only — you don't pass these to analyze.
clauses[].id is what POST /api/v1/snapreport/analyze returns as suggestions[].clause_id; clauses[].number matches suggestions[].clause_code.

1# All clauses by standard code (no UUID required)
2curl https://api.myqateam.com/api/v1/standards/IFS-FOOD/clauses \
3  -H "Authorization: Bearer myqa_..."
4
5# Or by UUID
6curl https://api.myqateam.com/api/v1/standards/<standard-uuid>/clauses \
7  -H "Authorization: Bearer myqa_..."
8
9# Filter to a specific chapter by number
10curl "https://api.myqateam.com/api/v1/standards/IFS-FOOD/clauses?chapter=1" \
11  -H "Authorization: Bearer myqa_..."

Response

json

1{
2  "success": true,
3  "data": {
4    "standard": {
5      "id": "4c111998-16c1-4e32-9cde-cfde90b955d9",
6      "code": "IFS-FOOD",
7      "name": "IFS Food",
8      "version": "8",
9      "default_language": "en",
10      "grading_scheme": "IFS"
11    },
12    "chapters": [
13      {
14        "id": "b12696aa-e6f4-4b37-828c-46a363e86d64",
15        "number": "1",
16        "title": "Governance and commitment",
17        "display_order": 1
18      }
19    ],
20    "sections": [
21      {
22        "id": "acb46b67-ebb8-4ba8-acd4-537edd2942b8",
23        "chapter_id": "b12696aa-e6f4-4b37-828c-46a363e86d64",
24        "number": "1.1",
25        "title": "Policy",
26        "display_order": 1
27      }
28    ],
29    "clauses": [
30      {
31        "id": "b011ab64-32b9-4dae-b8bd-499311322827",
32        "section_id": "acb46b67-ebb8-4ba8-acd4-537edd2942b8",
33        "parent_clause_id": null,
34        "number": "1.1.1",
35        "title": null,
36        "display_order": 1
37      }
38    ]
39  }
40}

Field reference

Field	Type	Description
`standard.id`	uuid	Pass as `standard_id` in the analyze request body.
`standard.code`	string	Short identifier (e.g. `ISO 9001`, `IFS-FOOD`).
`chapters[].id`	uuid	Pass any subset in the `processes` array of an analyze request to scope grading to those chapters.
`chapters[].number`	string	Human-readable chapter number (e.g. `1`, `4`).
`sections[].chapter_id`	uuid	The parent chapter UUID.
`clauses[].id`	uuid	Clause UUID. Returned by analyze as `suggestions[].clause_id`.
`clauses[].section_id`	uuid	The parent section UUID.
`clauses[].parent_clause_id`	uuid \u007c null	For nested sub-clauses; `null` for top-level clauses.
`clauses[].number`	string	The clause code (e.g. `1.1.1`, `4.1`) — returned by analyze as `suggestions[].clause_code`.

Errors

HTTP	Field	Description
400	`INVALID_INPUT`	`standardId` path segment is not a UUID.
401	`UNAUTHORIZED`	Missing, invalid, or revoked API key (or IP not allowlisted).
404	`STANDARD_NOT_FOUND`	The supplied `standardId` does not exist.
500	`PROCESSING_ERROR`	Database error while loading standards or clauses.

See the full error code reference on the authentication page.