> ## Documentation Index
> Fetch the complete documentation index at: https://docs.printools.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

> The /v1 REST API a shop can hand to a third party.

Build integrations with the PRINTOOLS public REST API. Use it to read and manage quotes, jobs, customers, catalogue items, and the other resources listed in this reference.

## Base URL

`https://api.printools.io`

Every endpoint on this tab is generated from the published [OpenAPI specification](https://d1zl72794e73i2.cloudfront.net/openapi.json). Expand a resource in the sidebar to see its operations, request parameters, response schemas, and code examples.

## Make your first request

Create a key in **Settings → API** in the [PRINTOOLS app](https://app.printools.io). Keep it on your server.

```bash theme={"dark"}
curl 'https://api.printools.io/v1/me' \
  -H "X-API-Key: ${PRINTOOLS_API_KEY}"
```

A tenant key is bound to one shop. It does not require an organisation header. [Partner credentials](/api/authentication#partner-credentials) use a different combination of headers.

<CardGroup cols={2}>
  <Card title="Authentication" icon="key" href="/api/authentication">
    Authenticate with a tenant key or partner credentials.
  </Card>

  <Card title="Get current account" icon="user" href="/api/reference/get_v1_me">
    Check the organisation, credential, and scopes for your request.
  </Card>

  <Card title="Scopes" icon="shield-check" href="/api/scopes">
    Find the permissions required by each operation.
  </Card>

  <Card title="Writing safely" icon="fingerprint" href="/api/idempotency">
    Use idempotency keys when retrying writes.
  </Card>
</CardGroup>

## Try an endpoint

Open an endpoint page, enter your credentials, and inspect its request and response schema before sending a request.

<Warning>
  Requests sent from the API playground reach the production API. Write operations can change your shop's data.
</Warning>

## Download the contract

[Download OpenAPI JSON](https://d1zl72794e73i2.cloudfront.net/openapi.json) to import the API into your client or generate an SDK. This reference documents the operations in that specification.
