> For the complete documentation index, see [llms.txt](https://pavewise.gitbook.io/pavewise-style-guide-and-more/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://pavewise.gitbook.io/pavewise-style-guide-and-more/api/overview.md).

# Overview

1. [**Introduction**](/pavewise-style-guide-and-more/api/introduction.md): Brief overview of the API's purpose.
2. [**Authentication**](/pavewise-style-guide-and-more/api/authentication.md): Details on how clients should authenticate requests.
3. [**Versioning**](/pavewise-style-guide-and-more/api/versioning.md): How different versions of the API are managed.
4. [**HTTP Methods**](/pavewise-style-guide-and-more/api/http-methods.md): Clear guidelines on which HTTP method to use for which type of operation.
5. [**Endpoints**](/pavewise-style-guide-and-more/api/endpoints.md): Explanation of resource naming conventions, path structures, etc.
6. [**Query Params**](/pavewise-style-guide-and-more/api/query-params.md): Usage of common query parameters like sorting, filtering, limiting, etc.
7. [**Request & Response Format**](/pavewise-style-guide-and-more/api/request-and-response-format.md): Standardizing request payloads and response structures.
8. [**Error Handling**](/pavewise-style-guide-and-more/api/error-handling.md): How errors are communicated to the client.
9. [**Status Codes**](/pavewise-style-guide-and-more/api/status-codes.md): Explanation of HTTP status codes used.
10. [**Database Relationship Types**](/pavewise-style-guide-and-more/api/database-relationship-types.md): Clarifying one-to-one, one-to-many, and many-to-many relationships and how they're handled.
11. [**Examples**](/pavewise-style-guide-and-more/api/examples.md): Providing concrete examples of typical API requests and responses.
12. [**Additional Topics**](/pavewise-style-guide-and-more/api/additional-topics.md)
13. [**👩‍🏫 Learning Resources**](/pavewise-style-guide-and-more/api/learning-resources.md)

***

### API Overview (with query params)

<figure><img src="https://2248755224-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FkVQm1PpPMvCvQccIZPyj%2Fuploads%2FZtvuy7op7bYDF4CUetos%2FAPIdesign_all.png?alt=media&amp;token=2d69cbdc-5118-41af-8af0-ec18a6f38816" alt=""><figcaption><p>Query Params section is not reflective of our actual query params (this table is from during the API schema redesign)</p></figcaption></figure>