Mist API Reference
Mist Automation Guide
HomeSDKsAPI ReferenceContext Plugin
MspsOrgs

searchMspOrgs

GET
/api/v1/msps/{msp_id}/orgs/search

Search organizations under this MSP using organization identifiers, names, subscription state, trial state, usage types, and time-based filters. Only organizations with at least one claimed device are returned.

Authorization

Authorization<token>

Preferred authentication method for automation and integrations. Send the API token in the HTTP Authorization header.

Format: Authorization: Token {apitoken}

Notes:

  • An API token generated for a specific admin has the same privileges as that admin
  • An API token is automatically removed if it is not used for more than 90 days
  • SSO admins cannot generate admin API tokens. Use organization API tokens when scoped Org/Site privileges are needed.

In: header

Path Parameters

msp_id*string
Formatuuid

Query Parameters

name?string

Filter results by name

org_id?string

Filter results by organization identifier

Formatuuid
sub_insufficient?boolean

If this org has sufficient subscription

trial_enabled?boolean

If this org is under trial period

usage_types?array<string>

List of types that enabled by usage

limit?integer

Maximum number of results to return per page

Range0 <= value
Default100
sort?string

On which field the list should be sorted, -prefix represents DESC order

Default"timestamp"
start?string

Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as -1d or -1w

end?string

Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as -1d, -2h, or now

search_after?string

Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the next URL from the previous response and should not be manually constructed.

Response Body

curl -X GET "https://example.com/api/v1/msps/000000ab-00ab-00ab-00ab-0000000000ab/orgs/search"
{  "end": 1614383378.4365287,  "limit": 10,  "next": "/api/v1/msps/43e96c5a-6ef6-11e6-9909-9596d1d1534f/orgs/search?end=1760601621&limit=1&search_after=%5B1760599794477%5D&start=1759996821",  "results": [    {      "msp_id": "d287e62f-0000-0000-0000-f2b9ba0a531f",      "name": "Test Org",      "num_aps": 9,      "num_sites": 5,      "num_switches": 1,      "num_unassigned_aps": 1,      "org_id": "bb1a8bf6-0000-0000-0000-8053a663cf65",      "sub_ana_required": 9,      "sub_ast_entitled": 5,      "sub_ast_required": 3,      "sub_eng_required": 3,      "sub_ex12_required": 1,      "sub_insufficient": true,      "sub_man_required": 9,      "sub_vna_entitled": 1,      "timestamp": 1614322563.513937,      "trial_enabled": false,      "usage_types": [        "sub_eng"      ]    },    {      "msp_id": "d287e62f-0000-0000-0000-f2b9ba0a531f",      "name": "Rogue Test1",      "num_aps": 1,      "num_sites": 1,      "org_id": "0fb81690-0000-0000-0000-9596d1d1534f",      "sub_ana_entitled": 1,      "sub_ana_required": 1,      "sub_insufficient": false,      "sub_man_entitled": 1,      "sub_man_required": 1,      "timestamp": 1614309876.500955    }  ],  "start": 1613778578.4365668,  "total": 2}

listMspOrgStats GET

List organization statistics for organizations managed by this MSP, including device, inventory, site, and SLE summary fields.

getMspSle GET

Return MSP-level SLE insight metrics for the selected metric and time range. Depending on the metric, the response can include all organizations or the worst-performing organizations in the MSP.