Organisations
Organisation discovery routes accept an authenticated user or the server-side
clientapisecret.
List organisations
Section titled “List organisations”GET /blendxapi/discovery/organisations/| Query parameter | Default | Description |
|---|---|---|
fields | full | Use basic for identity fields only or full for branding. |
search | empty | Match the display name; basic mode also matches short_name. |
The response contains an organisations array. It is not paginated.
Basic fields
Section titled “Basic fields”| Field | Description |
|---|---|
id | Organisation UUID required by discovery checkout. |
name | Learner-facing organisation display name. |
short_name | Stable Open edX/Hasura tenant key. |
created_at | Organisation creation timestamp. |
Full fields
Section titled “Full fields”The default full response contains every basic field plus:
| Field | Description |
|---|---|
logo_url | Organisation logo URL, or null when not configured. |
favicon_url | Organisation favicon URL, or null when not configured. |
trademark_url | Organisation trademark asset URL, or null when not configured. |
curl "https://<LMS_HOST>/blendxapi/discovery/organisations/?fields=basic&search=acme" \ -H "clientapisecret: $BLENDX_CLIENT_API_SECRET"Load marketing page metadata
Section titled “Load marketing page metadata”GET /blendxapi/discovery/marketing-page-metadata/The response is an array—not an envelope—and includes only organisations with non-empty metadata:
[ { "organisation_id": "organisation-uuid", "marketing_page_metadata": { "headline": "Develop practical safety skills" } }]marketing_page_metadata is organisation-defined. Treat it as an extensible
object and tolerate unknown keys.