ENendless
admin
organizations

List Organizations

Get list of all organizations. Requires organization:view_organization permission.

get/api/v3/admin/organizations/

Request

  • Base URL
    https://api.endless.health (the document declares no server; this is the origin it was published from)
  • Auth
    none declared

Query parameters

organization_type'ENTITY' | 'SPONSOR' | 'CAMPAIGN'

Discriminates the kind of organization row.

ENTITY: standalone customer account. SPONSOR: parent account that runs one or more campaigns. CAMPAIGN: a child organization for a single screening program; requires parent_id.

Filter to a single organization type.

Response

Successful Response

idinteger required
identifierstring required
namestring required
configsobject nullable required
organization_type'ENTITY' | 'SPONSOR' | 'CAMPAIGN' required

Discriminates the kind of organization row.

ENTITY: standalone customer account. SPONSOR: parent account that runs one or more campaigns. CAMPAIGN: a child organization for a single screening program; requires parent_id.

activeboolean required

Changes

No recorded changes to this operation across all 2 revisions of this API.