# Postman collection

Every endpoint in the v3 API, as a Postman collection. It matches the
[reference](/api/v3).

<a href="/docs/nifty-v3.postman_collection.json" target="_blank" rel="noreferrer" download>
  Download the collection
</a>

## Import it

1. In Postman: **Import → File** and pick the file you just downloaded.
2. Open the collection's **Variables** tab and set **`niftyToken`** to a
   Personal Access Token or an OAuth access token — see
   [Authentication](/authentication). Leave `baseUrl` as it is.
3. Send **Actor → List actors**. A `200` with a JSON body means the token
   works; a `401` means it does not.

Authorization is set once, on the collection, as a bearer token. Every request
inherits it — there is no per-request auth to fill in.

## What is in it

- One folder per resource, in the same order as the reference sidebar.
- Path parameters are Postman path variables (`:id`), listed under the
  request's **Params** tab with the description from the reference.
- Query parameters (`expand`, filters, pagination) ship **disabled**, so a
  request sends only what you switch on.
- Request bodies are pre-filled with the **required** fields and their example
  values. Optional fields are not included. The [reference](/api/v3) is the
  full field list.
- `Idempotency-Key` is present but disabled on the endpoints that accept it.
  Switch it on and set a fresh value per distinct request.

## Keeping it current

The collection is built from the same API description the reference renders, so
re-downloading it after a [changelog](/changelog) entry is all it takes.