List the user's organisations
Every organisation the signed-in user belongs to, with their role in it, by name; one page (at most 100). A user's token only: an API key, a machine client or a support session answers 403 permission_denied. Switching organisation means a new token for it.
- Scopesnone
- Rate classread
/v1/me/orgsEvery organisation the signed-in user belongs to, with their role in it, by name; one page (at most 100). A user's token only: an API key, a machine client or a support session answers 403 permission_denied. Switching organisation means a new token for it.
Authorization
apiKey An API key (fo_live_… / fo_test_…) as a bearer token
In: header
Header Parameters
Dated API version; pinned per organisation on first use and overridable per request
Value in
- "2026-10-01"
- "2026-10-04"
The data the request acts on: test is the organisation's sandbox. An OAuth token picks it (live by default); an API key's mode is fixed, and naming the other one is refused
Value in
- "live"
- "test"
ETag of a cached representation; a match returns 304
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X GET "https://example.com/v1/me/orgs"{ "object": "list", "data": [ { "object": "membership", "organisation": { "object": "organisation", "id": "string", "name": "string", "slug": "string", "kind": "retailer" }, "role": "owner" } ], "has_more": true, "next_cursor": "string"}Read the caller's organisation GET
The organisation the credential belongs to: its ID, name and slug, and its plan with the features it switches on. A rename or a plan change reaches it within seconds.
Read one meter over time GET
One meter by hour (up to 7 days) or by day (up to 400 days), in the caller's mode; periods without usage are left out. A level meter's point is its highest reading in the period.