List Provider Organizations
This endpoint returns a list of the Organizations associated with the Provider. You must be associated with the provider to use this route.
Request
- Base URLhttps://console.jumpcloud.com/api/v2
- AuthAPI key in header x-api-key
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
The comma separated fields included in the returned records. If omitted, the default list of fields will be returned.
A filter to apply to the query.
Filter structure: <field>:<operator>:<value>.
field = Populate with a valid field from an endpoint response.
operator = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. Note: v1 operators differ from v2 operators.
value = Populate with the value you want to search for. Is case sensitive. Supports wild cards.
EX: GET /api/v2/groups?filter=name:eq:Test+Group
The number of records to return at once. Limited to 100.
The offset into the records to return.
The comma separated fields used to sort the collection. Default sort is ascending, prefix with - to sort descending.
The comma separated fields used to sort the collection, ignoring case. Default sort is ascending, prefix with - to sort descending.
Response
Example response
{
"results": [
{
"id": "624d9eae6849cf3b3f93dc56",
"name": "Acme Inc"
}
]
}Changes
No recorded changes to this operation across all 1 revision of this API.