Skip to content
PARTYPPLDevelopers
NederlandsTo partyppl.nl

Reference

Token

What the token you are using may do and has used.

What the token you are using is allowed to do.

GET/me

What this token is

Access
Token with read
operationId
getMe

The organisation this token belongs to, the scopes it carries, the limits that apply to it and what it has spent today. Useful as a first call to check a token works.

Example request

curl
curl -s "https://api.partyppl.nl/v1/me" \
  -H "Authorization: Bearer $PPL_TOKEN"
JavaScript
const res = await fetch("https://api.partyppl.nl/v1/me", {
  headers: {
    Authorization: `Bearer ${process.env.PPL_TOKEN}`,
  },
});
if (!res.ok) throw new Error((await res.json()).error.message);
const { data, meta } = await res.json();
Python
import os
import requests

res = requests.get(
    "https://api.partyppl.nl/v1/me",
    headers={"Authorization": f"Bearer {os.environ['PPL_TOKEN']}"},
    timeout=30,
)
res.raise_for_status()
payload = res.json()
Show the example response
200 · Example response
{
  "data": {
    "token": {
      "id": "tok_7f3a",
      "name": "Website",
      "prefix": "ppl_live_",
      "scopes": [
        "read"
      ],
      "created_at": 1758499200,
      "last_used_at": 1758585600
    },
    "organisation": {
      "id": "oost-collective",
      "name": "OOST Collective",
      "verified": true,
      "since": 2014,
      "bio": "Hard techno in Amsterdam Oost.",
      "website": "https://clubooost.nl",
      "events_count": 42,
      "url": "https://partyppl.nl/organisatie/oost-collective"
    },
    "rate_limit": {
      "per_minute": 120,
      "remaining_this_minute": 119,
      "per_day": 10000,
      "used_today": 41
    },
    "usage_today": [
      {
        "path": "/events",
        "count": 38
      },
      {
        "path": "/events/:id",
        "count": 3
      }
    ]
  },
  "meta": {
    "request_id": "9f1c2b4a-7e3d-4a10-9c2f-6b8d1e5a0c33"
  }
}

Statuses

  • 200What this token is
  • 400The request is wrong. error.details.params names every bad parameter.
  • 401No token, or a token we do not know.
  • 403The token is valid but does not carry the read scope, or the organisation is suspended.
  • 429Over the per-minute limit or the daily quota. Retry-After says how long to wait.
  • 500Something went wrong on our side. Quote request_id.

The specification as JSON