API overview

The Geta.Team API lets your own backend work with your account: follow the workspaces you created for your clients, and hear of each change through a webhook.

Base URL

https://dash.geta.team/api/v1

Request and response bodies are JSON (Content-Type: application/json).

Authentication

Create a key in your dashboard, in Account, section API:

Give it a name.
Choose its access: read and write, or read-only (follow your workspaces, change nothing).
Enter the IP addresses it will be used from: one IP or range per line, like 203.0.113.10 or 198.51.100.0/24. Required: a call from any other address is refused, even with the right key. The dashboard offers to add your current IP.

Then copy it. The key is shown only once; we keep only a fingerprint of it. You can change a key's addresses at any time.

Send it in the Authorization header of every call:

curl https://dash.geta.team/api/v1/me \
  -H "Authorization: Bearer gat_sk_..."

{ "id": 42, "email": "[email protected]" }

An account holds up to 10 live keys. Revoke one in the dashboard and any program using it stops at once.
Each new key sends an alert email to the account's owner, with the key's name and first characters (never the key itself).
Keep keys on your server: never in a web page or a mobile app.

Errors

An error is a status code and a body a program can read:

{ "error": { "code": "not_found", "message": "No such workspace" } }

Status	`code`	Meaning
400	`invalid_request`	A field is missing or wrong; `message` says which
401	`unauthorized`	No key, an unknown or a revoked key
403	`ip_not_allowed`	The key may not be used from this address; `ip` says which address we saw: add it to the key
403	`insufficient_scope`	The key does not have the access this call needs
404	`not_found`	No such workspace on your account
429	`rate_limited`	Too many requests for this key, retry in a minute
500	`internal_error`	Something went wrong on our side; our team is alerted

Error messages are in English; rely on the code.

Rate limit

120 requests per minute and per key. Past it, the API answers 429 with rate_limited; the RateLimit-* headers say how many are left and when the window resets.

Interactive reference and OpenAPI

Every call, its fields, answers and errors, with a button to try it with your key: the interactive reference (add your current IP to the key to try calls from your browser). It is built from the OpenAPI 3.1 file, geta-team-api-v1.yaml, that you can also import in Postman, Insomnia or a client generator.