DevelopersPlus
Connect Pattlist to your own tools with API keys
Create a Pattlist API key with exactly the permissions you need, use it to read or update your shopping lists from scripts and dashboards, and revoke it.
Updated October 23, 2026
What you can do with the API
Pattlist’s API lets your own scripts and tools work with your lists: show your shopping list on a kitchen dashboard, add items from a home-automation routine, or export what you buy. You authenticate with an API key that you create in the app. API keys are part of Pattlist Plus.
Create an API key
- Open Settings (tap your profile picture at the top right), and under DEVELOPER tap Developer API.
- Tap Create API key.
- Give it a name that says where it’s used, such as “Home automation”.
- Choose its Permissions: tap Select read-only for all the read permissions, Select all for everything, or pick them one by one. Pattlist tells you if the name or permissions are missing.
- Tap Create, then Copy to clipboard and store the key somewhere safe.
Permissions
Give each key only the permissions it needs. A key can never reach lists you can’t access in the app.
| In the app | Scope | Allows |
|---|---|---|
| Read lists | lists:read | List metadata for your account |
| Write lists | lists:write | Create, update, and delete lists |
| Read items | items:read | Read list items |
| Write items | items:write | Create, update, and delete items |
| Read item photos | attachments:read | List item photos and download URLs |
| Read members | memberships:read | See who is on a list |
| Read invites | invites:read | See pending invites |
| Manage sharing | sharing:write | Invite, remove members, and change roles |
| Read recommendations | recommendations:read | Fetch list recommendations |
| Write recommendations | recommendations:write | Record a suggestion as accepted or dismissed |
| Sync pull | sync:read | Download changes via sync pull |
A request without the permission it needs is refused. For example, a read-only key can read your lists but can’t create one.
Use a key
Send the key as a bearer token to https://api.pattlist.com:
curl https://api.pattlist.com/v1/lists \
-H "Authorization: Bearer <your API key>"Changes made through the API reach the app like any other change. The API reference documents the read endpoints, their parameters and responses. Reference pages for the write endpoints are on the way.
Please keep to fair use: no more than 60 requests per minute per key.
Limits, revoking and Plus
- You can have up to 10 active keys. Revoke one you no longer use to make room.
- To revoke a key, choose it on the Developer API screen and confirm. It stops working straight away.
- Keys only work while you have Plus. If your subscription ends, they stop working, and start again when you re-subscribe. Being a member of someone else’s Plus list doesn’t let you create keys.