Documentation · API reference
GET
/api/v1/admin/accountsEvery account, searched, filtered and sorted
This page as Markdown, or in an AI chatMore ways to read this page
Every account, searched, filtered and sorted. Operators only.
# Every account, searched, filtered and sorted
> tidekeeper's API reference: https://tidekeeper.eu/docs/api/get-admin-accounts
`GET /api/v1/admin/accounts`
Every account, searched, filtered and sorted. Operators only.
## Parameters
- `q` (in query): Looked for in names, addresses and sites
- `plan` (in query): A plan's id
- `state` (in query): A subscription's state, or held, suspended, deletion
- `sort` (in query): age, usage or seen
## The answer
200, `AdminAccounts`
- `now` (integer, needed)
- `plans` (list of PlanView, needed)
- `rows` (list of AdminAccountRow, needed)
- `total` (integer, needed): How many there are before the search and the filters.
## Asking
```sh
curl https://tidekeeper.eu/api/v1/admin/accounts \
-H "Authorization: Bearer $TIDEKEEPER_TOKEN"
```
Parameters
- qin the query
- Looked for in names, addresses and sites
- planin the query
- A plan's id
- statein the query
- A subscription's state, or held, suspended, deletion
- sortin the query
- age, usage or seen
The answer
Status 200
AdminAccounts
- now
- integerneeded
- plans
- list of PlanViewneeded
- rows
- list of AdminAccountRowneeded
- total
- integerneededHow many there are before the search and the filters.
Asking
curl https://tidekeeper.eu/api/v1/admin/accounts \ -H "Authorization: Bearer $TIDEKEEPER_TOKEN"
const answer = await fetch("https://tidekeeper.eu/api/v1/admin/accounts", { headers: { Authorization: `Bearer ${process.env.TIDEKEEPER_TOKEN}`, }, }).then((r) => r.json());