Skip to content

Organisations

Organisation discovery routes accept an authenticated user or the server-side clientapisecret.

GET /blendxapi/discovery/organisations/
Query parameterDefaultDescription
fieldsfullUse basic for identity fields only or full for branding.
searchemptyMatch the display name; basic mode also matches short_name.

The response contains an organisations array. It is not paginated.

FieldDescription
idOrganisation UUID required by discovery checkout.
nameLearner-facing organisation display name.
short_nameStable Open edX/Hasura tenant key.
created_atOrganisation creation timestamp.

The default full response contains every basic field plus:

FieldDescription
logo_urlOrganisation logo URL, or null when not configured.
favicon_urlOrganisation favicon URL, or null when not configured.
trademark_urlOrganisation trademark asset URL, or null when not configured.
Terminal window
curl "https://<LMS_HOST>/blendxapi/discovery/organisations/?fields=basic&search=acme" \
-H "clientapisecret: $BLENDX_CLIENT_API_SECRET"
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.