Documentation · API reference
GET
/api/v1/aboutWhat anyone may know of this deployment
This page as Markdown, or in an AI chatMore ways to read this page
What anyone may know of this deployment: how to reach whoever runs it, what it publishes, and whether customers get the command line.
# What anyone may know of this deployment
> tidekeeper's API reference: https://tidekeeper.eu/docs/api/get-about
`GET /api/v1/about`
What anyone may know of this deployment: how to reach whoever runs it, what it publishes, and whether customers get the command line.
## The answer
200, `About`
- `address` (string): This tidekeeper's own address, as its pages and API are reached: the documentation's lines are written with it.
- `cli` (boolean, needed): Customers are offered the command line (CL-09).
- `cli_downloads` (boolean): The command line can be downloaded here (`/install.sh`).
- `company` (string or null): Who runs this tidekeeper, as one line for every footer (`TIDEKEEPER_COMPANY`): "Point Free ApS · Denmark · CVR 46560590".
- `contact` (string or null): The address shown where the law asks for one (the company page and the privacy policy), where one was given.
- `contact_form` (boolean): Messages can be sent from the contact page (`/contact`): there is an address for them and a mail server to take them.
- `countries_by` (string or null): Whose data the countries are, where its licence asks to be named (`DB-IP`): How it counts and Places say so, with a link.
- `phone` (string or null): A telephone number for the contact page (`TIDEKEEPER_PHONE`).
- `sells` (boolean): Plans are sold here: the footers offer cancelling one without signing in (`/cancel`).
- `texts` (list of TextLink, needed): The texts this deployment publishes, in the order they are listed.
## Asking
```sh
curl https://tidekeeper.eu/api/v1/about \
-H "Authorization: Bearer $TIDEKEEPER_TOKEN"
```
The answer
Status 200
About
- address
- stringThis tidekeeper's own address, as its pages and API are reached: the documentation's lines are written with it.
- cli
- booleanneededCustomers are offered the command line (CL-09).
- cli_downloads
- booleanThe command line can be downloaded here (`/install.sh`).
- company
- string or nullWho runs this tidekeeper, as one line for every footer (`TIDEKEEPER_COMPANY`): "Point Free ApS · Denmark · CVR 46560590".
- contact
- string or nullThe address shown where the law asks for one (the company page and the privacy policy), where one was given.
- contact_form
- booleanMessages can be sent from the contact page (`/contact`): there is an address for them and a mail server to take them.
- countries_by
- string or nullWhose data the countries are, where its licence asks to be named (`DB-IP`): How it counts and Places say so, with a link.
- phone
- string or nullA telephone number for the contact page (`TIDEKEEPER_PHONE`).
- sells
- booleanPlans are sold here: the footers offer cancelling one without signing in (`/cancel`).
- texts
- list of TextLinkneededThe texts this deployment publishes, in the order they are listed.
Asking
curl https://tidekeeper.eu/api/v1/about \ -H "Authorization: Bearer $TIDEKEEPER_TOKEN"
const answer = await fetch("https://tidekeeper.eu/api/v1/about", { headers: { Authorization: `Bearer ${process.env.TIDEKEEPER_TOKEN}`, }, }).then((r) => r.json());