> For the complete documentation index, see [llms.txt](https://docs.bugbug.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.bugbug.io/public-api-reference/suites.md).

# Suites

Retrieving suites

## Retrieving suites list

> Returns many suites.

```json
{"openapi":"3.1.0","info":{"title":"BugBug.io Public API","version":"v2"},"tags":[{"name":"Suites","description":"Retrieving suites"}],"security":[{"tokenAuth":[]},{"Bearer":[]}],"components":{"securitySchemes":{"tokenAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"Token-based authentication with required prefix \"Token\""}},"schemas":{"PaginatedV2SuiteList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true,"format":"uri"},"previous":{"type":"string","nullable":true,"format":"uri"},"results":{"type":"array","items":{"$ref":"#/components/schemas/V2Suite"}}}},"V2Suite":{"type":"object","properties":{"id":{"type":"string","format":"uuid","readOnly":true},"name":{"type":["string","null"],"readOnly":true},"testsCount":{"type":"integer","readOnly":true},"tests":{"type":"array","items":{"type":"object","additionalProperties":{}},"readOnly":true},"autoAddNewTests":{"type":"boolean","readOnly":true},"autoRetry":{"type":"integer","readOnly":true},"notes":{"type":["string","null"],"readOnly":true,"title":"Suite notes"},"runInParallel":{"type":"boolean","readOnly":true},"runProfileId":{"type":["string","null"],"format":"uuid","readOnly":true}},"required":["autoAddNewTests","autoRetry","id","name","notes","runInParallel","runProfileId","tests","testsCount"]}}},"paths":{"/api/v2/suites/":{"get":{"operationId":"v2_suites_list","description":"Returns many suites.","summary":"Retrieving suites list","parameters":[{"in":"query","name":"ordering","schema":{"type":"string","enum":["-created","-name","created","name"]}},{"name":"page","required":false,"in":"query","description":"A page number within the paginated result set.","schema":{"type":"integer"}},{"name":"page_size","required":false,"in":"query","description":"Number of results to return per page.","schema":{"type":"integer"}},{"in":"query","name":"query","schema":{"type":"string"},"description":"Search in names with the following query"}],"tags":["Suites"],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedV2SuiteList"}}},"description":""},"401":{"description":"Authentication credentials were missing or invalid."}}}}}}
```

## Create new suite

> Creates a suite.

```json
{"openapi":"3.1.0","info":{"title":"BugBug.io Public API","version":"v2"},"tags":[{"name":"Suites","description":"Retrieving suites"}],"security":[{"tokenAuth":[]},{"Bearer":[]}],"components":{"securitySchemes":{"tokenAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"Token-based authentication with required prefix \"Token\""}},"schemas":{"V2SuiteCreate":{"type":"object","properties":{"autoAddNewTests":{"type":"boolean"},"autoRetry":{"type":"integer","maximum":5,"minimum":0},"notes":{"type":["string","null"],"title":"Suite notes"},"name":{"type":["string","null"],"maxLength":100},"runInParallel":{"type":"boolean"},"runProfileId":{"type":"string","format":"uuid"},"tests":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["runProfileId"]},"V2Suite":{"type":"object","properties":{"id":{"type":"string","format":"uuid","readOnly":true},"name":{"type":["string","null"],"readOnly":true},"testsCount":{"type":"integer","readOnly":true},"tests":{"type":"array","items":{"type":"object","additionalProperties":{}},"readOnly":true},"autoAddNewTests":{"type":"boolean","readOnly":true},"autoRetry":{"type":"integer","readOnly":true},"notes":{"type":["string","null"],"readOnly":true,"title":"Suite notes"},"runInParallel":{"type":"boolean","readOnly":true},"runProfileId":{"type":["string","null"],"format":"uuid","readOnly":true}},"required":["autoAddNewTests","autoRetry","id","name","notes","runInParallel","runProfileId","tests","testsCount"]}}},"paths":{"/api/v2/suites/":{"post":{"operationId":"v2_suites_create","description":"Creates a suite.","summary":"Create new suite","parameters":[],"tags":["Suites"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V2SuiteCreate"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V2Suite"}}},"description":""},"400":{"description":"Request body failed validation."},"401":{"description":"Authentication credentials were missing or invalid."}}}}}}
```

## Retrieving suite by ID

> Returns a single suite.

```json
{"openapi":"3.1.0","info":{"title":"BugBug.io Public API","version":"v2"},"tags":[{"name":"Suites","description":"Retrieving suites"}],"security":[{"tokenAuth":[]},{"Bearer":[]}],"components":{"securitySchemes":{"tokenAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"Token-based authentication with required prefix \"Token\""}},"schemas":{"V2Suite":{"type":"object","properties":{"id":{"type":"string","format":"uuid","readOnly":true},"name":{"type":["string","null"],"readOnly":true},"testsCount":{"type":"integer","readOnly":true},"tests":{"type":"array","items":{"type":"object","additionalProperties":{}},"readOnly":true},"autoAddNewTests":{"type":"boolean","readOnly":true},"autoRetry":{"type":"integer","readOnly":true},"notes":{"type":["string","null"],"readOnly":true,"title":"Suite notes"},"runInParallel":{"type":"boolean","readOnly":true},"runProfileId":{"type":["string","null"],"format":"uuid","readOnly":true}},"required":["autoAddNewTests","autoRetry","id","name","notes","runInParallel","runProfileId","tests","testsCount"]}}},"paths":{"/api/v2/suites/{id}/":{"get":{"operationId":"v2_suites_retrieve","description":"Returns a single suite.","summary":"Retrieving suite by ID","parameters":[{"in":"path","name":"id","schema":{"type":"string","format":"uuid"},"description":"A UUID string identifying this suite.","required":true}],"tags":["Suites"],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V2Suite"}}},"description":""},"401":{"description":"Authentication credentials were missing or invalid."},"404":{"description":"Resource not found."}}}}}}
```

## Update suite by ID

> Updates a suite.

```json
{"openapi":"3.1.0","info":{"title":"BugBug.io Public API","version":"v2"},"tags":[{"name":"Suites","description":"Retrieving suites"}],"security":[{"tokenAuth":[]},{"Bearer":[]}],"components":{"securitySchemes":{"tokenAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"Token-based authentication with required prefix \"Token\""}},"schemas":{"V2SuiteCreate":{"type":"object","properties":{"autoAddNewTests":{"type":"boolean"},"autoRetry":{"type":"integer","maximum":5,"minimum":0},"notes":{"type":["string","null"],"title":"Suite notes"},"name":{"type":["string","null"],"maxLength":100},"runInParallel":{"type":"boolean"},"runProfileId":{"type":"string","format":"uuid"},"tests":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["runProfileId"]},"V2Suite":{"type":"object","properties":{"id":{"type":"string","format":"uuid","readOnly":true},"name":{"type":["string","null"],"readOnly":true},"testsCount":{"type":"integer","readOnly":true},"tests":{"type":"array","items":{"type":"object","additionalProperties":{}},"readOnly":true},"autoAddNewTests":{"type":"boolean","readOnly":true},"autoRetry":{"type":"integer","readOnly":true},"notes":{"type":["string","null"],"readOnly":true,"title":"Suite notes"},"runInParallel":{"type":"boolean","readOnly":true},"runProfileId":{"type":["string","null"],"format":"uuid","readOnly":true}},"required":["autoAddNewTests","autoRetry","id","name","notes","runInParallel","runProfileId","tests","testsCount"]}}},"paths":{"/api/v2/suites/{id}/":{"put":{"operationId":"v2_suites_update","description":"Updates a suite.","summary":"Update suite by ID","parameters":[{"in":"path","name":"id","schema":{"type":"string","format":"uuid"},"description":"A UUID string identifying this suite.","required":true}],"tags":["Suites"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V2SuiteCreate"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V2Suite"}}},"description":""},"400":{"description":"Request body failed validation."},"401":{"description":"Authentication credentials were missing or invalid."},"404":{"description":"Resource not found."}}}}}}
```

## Removing a suite

> Remove a suite.

```json
{"openapi":"3.1.0","info":{"title":"BugBug.io Public API","version":"v2"},"tags":[{"name":"Suites","description":"Retrieving suites"}],"security":[{"tokenAuth":[]},{"Bearer":[]}],"components":{"securitySchemes":{"tokenAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"Token-based authentication with required prefix \"Token\""}}},"paths":{"/api/v2/suites/{id}/":{"delete":{"operationId":"v2_suites_destroy","description":"Remove a suite.","summary":"Removing a suite","parameters":[{"in":"path","name":"id","schema":{"type":"string","format":"uuid"},"description":"A UUID string identifying this suite.","required":true}],"tags":["Suites"],"responses":{"204":{"description":"No response body"},"401":{"description":"Authentication credentials were missing or invalid."},"404":{"description":"Resource not found."}}}}}}
```

## Partially update suite by ID

> Partially updates a suite.

```json
{"openapi":"3.1.0","info":{"title":"BugBug.io Public API","version":"v2"},"tags":[{"name":"Suites","description":"Retrieving suites"}],"security":[{"tokenAuth":[]},{"Bearer":[]}],"components":{"securitySchemes":{"tokenAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"Token-based authentication with required prefix \"Token\""}},"schemas":{"PatchedV2SuiteCreate":{"type":"object","properties":{"autoAddNewTests":{"type":"boolean"},"autoRetry":{"type":"integer","maximum":5,"minimum":0},"notes":{"type":["string","null"],"title":"Suite notes"},"name":{"type":["string","null"],"maxLength":100},"runInParallel":{"type":"boolean"},"runProfileId":{"type":"string","format":"uuid"},"tests":{"type":"array","items":{"type":"string","format":"uuid"}}}},"V2Suite":{"type":"object","properties":{"id":{"type":"string","format":"uuid","readOnly":true},"name":{"type":["string","null"],"readOnly":true},"testsCount":{"type":"integer","readOnly":true},"tests":{"type":"array","items":{"type":"object","additionalProperties":{}},"readOnly":true},"autoAddNewTests":{"type":"boolean","readOnly":true},"autoRetry":{"type":"integer","readOnly":true},"notes":{"type":["string","null"],"readOnly":true,"title":"Suite notes"},"runInParallel":{"type":"boolean","readOnly":true},"runProfileId":{"type":["string","null"],"format":"uuid","readOnly":true}},"required":["autoAddNewTests","autoRetry","id","name","notes","runInParallel","runProfileId","tests","testsCount"]}}},"paths":{"/api/v2/suites/{id}/":{"patch":{"operationId":"v2_suites_partial_update","description":"Partially updates a suite.","summary":"Partially update suite by ID","parameters":[{"in":"path","name":"id","schema":{"type":"string","format":"uuid"},"description":"A UUID string identifying this suite.","required":true}],"tags":["Suites"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchedV2SuiteCreate"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V2Suite"}}},"description":""},"400":{"description":"Request body failed validation."},"401":{"description":"Authentication credentials were missing or invalid."},"404":{"description":"Resource not found."}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.bugbug.io/public-api-reference/suites.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.