Msps

searchMspOrgGroup

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

Search MSP resources by query string. Currently type=orgs returns matching organizations in this MSP.

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

type*"orgs"

MSP search result type to return. enum: orgs

Value in

  • "orgs"
q*string

Filter results by search string

limit?integer

Maximum number of results to return per page

Range0 <= value
Default100
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

duration?string

Time range duration for the query, using relative units such as 10m, 7d, or 2w

Default"1d"
sort?string

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

Default"timestamp"

Response Body

curl -X GET "https://example.com/api/v1/msps/000000ab-00ab-00ab-00ab-0000000000ab/search?type=orgs&q=live"
{  "limit": 0,  "page": 0,  "results": [    {      "id": "b069b358-4c97-5319-1f8c-7c5ca64d6ab1",      "text": "string",      "type": "string"    }  ],  "total": 0}