List organizations

List the organizations behind the Signals this credential reads

API version

GET/v1/organizations

An Odyssey person signing in sees every organization in the estate; anyone else sees the one they belong to, and an API key sees the organizations of the Signals it was granted.

Authenticate with an API key in X-Api-Key, or a bearer token in Authorization: Bearer <token>.

Example request#

Shell

curl "https://api.odysseysignal.app/v1/organizations" \
  -H "X-Api-Key: $ODYSSEY_API_KEY"

Response 200#

application/json.

idstring · required
namestring · required
Readable name, always. Never the id: a listing of UUIDs cannot tell one customer from another, which makes the count and the link beside it meaningless.
signal_countinteger · required
signals_urlstring · required
This organization's Signals, already filtered.

Errors#

Errors are application/problem+json (RFC 9457): type, title, status, detail and, for some, more fields that say how to fix the call. The type is https://api.odysseysignal.app/problems/<code>.

Status	Code	When
400	`invalid-request`	The request is not valid for this DataSet; `detail` says why.
401	`unauthorized`	No credential, or one that is not accepted.
403	`forbidden`	The credential is valid but does not cover what was asked.
404	`not-found`	Nothing there, or nothing this credential may read.
422	`validation-failed`	The request does not match the contract; `errors` lists each field.
429	`rate_limited`	Too many requests, or the monthly quota is used up.
503	`unavailable`	A service behind the API did not answer; try again.