You and your company

GET/v1/organisation

The company, the shops this key reaches, and its people where the key's maker may see them.

What it does

People are listed by name and role name only, and only when the person who made the key may see people in the app. A key never reads an email address or a phone number here.

Who may call it

A key whose maker's role holds figures (see the figures), after the fence, for the shop or category it names.

Request

HTTP

GET https://panlytics.net/api/v1/organisation

Parameters

Name	In	Type	Required	What it is
`Authorization`	header	string	Yes	Bearer, a space, then the key.

Example request

curl https://panlytics.net/api/v1/organisation \
  -H "Authorization: Bearer $PANLYTICS_KEY"

import os

import requests

response = requests.get(
    "https://panlytics.net/api/v1/organisation",
    headers={"Authorization": f"Bearer {os.environ['PANLYTICS_KEY']}"},
    timeout=60,
)
response.raise_for_status()
print(response.json())

const response = await fetch("https://panlytics.net/api/v1/organisation", {
  headers: {
    Authorization: `Bearer ${process.env.PANLYTICS_KEY}`,
  },
});
if (!response.ok) throw new Error(`Panlytics answered ${response.status}`);
console.log(await response.json());

Response

200: The answer, as JSON.

Field	Type	Always there	What it is
`id`	integer	Yes	The company's id.
`name`	string	Yes	The company's name.
`country`	string or null	Yes	The country the company is in, or null.
`currency`	string	Yes	The company's currency, as a three-letter code.
`shops[]`	object[]	Yes	The shops this key reaches.
`shops[].id`	integer	Yes	The shop's id.
`shops[].name`	string	Yes	What the shop is called, as people in the company say it.
`shops[].branch`	string	Yes	The branch name, or empty.
`shops[].city`	string	Yes	The city the shop is in.
`shops[].country`	string	Yes	The country the shop is in, or empty.
`shops[].createdAt`	string (ISO 8601)	Yes	When the shop was made, in UTC.
`people[]`	object[] or null	Yes	Names and role names only, and only when the person who made the key may see people in the app. Never an email address or a phone number. Null otherwise.
`people[].name`	string	Yes	The person's name.
`people[].role`	string	Yes	The name of their role.

Example response

200

{
  "id": 3,
  "name": "Example Oy",
  "country": "Finland",
  "currency": "EUR",
  "shops": [
    {
      "id": 12,
      "name": "Harbour",
      "branch": "",
      "city": "Helsinki",
      "country": "Finland",
      "createdAt": "2026-10-01T08:00:00.000Z"
    }
  ],
  "people": [
    {
      "name": "Anna Virtanen",
      "role": "Manager"
    }
  ]
}

Errors

A refusal is JSON with a code, a sentence in error, and a requestId when the fault is ours. Read the code, not the sentence. Every code is listed on Errors.

Status	Code	When	What to do
401	`api.key_missing`	The call had no Authorization header.	Send the key in the Authorization header as Bearer, then call again.
401	`api.key_refused`	The key is wrong, revoked, past its end, or its maker or company no longer allows it (developer mode off, the maker removed or switched off, or the maker's role lost the developer ability).	Ask the person who gave you the key to make a new one.
401	`api.wrong_key_kind`	This key does not open these endpoints.	Use the key these endpoints were made for, or ask the person who gave you the key.
403	`refused`	The key's maker may not do this here: their role lacks the ability, or the shop or category is outside their reach.	Ask the CEO for a role that allows it, or call it for a shop or category the role reaches.
403	`auth.not_fresh`	This step needs you to prove it is you.	Confirm your password or passkey, then try again.
429	`api.rate_limited`	The key made more than 120 calls in this minute. Wait the seconds in Retry-After.	Wait the seconds in Retry-After, then call again.
500	`server`	Something failed on our side. The answer carries a requestId to quote.	Try again in a minute; if it keeps happening, report it.
503	`developer.unavailable`	API keys are not set up on this deployment yet.	Report it, and we will switch them on.