List an application's assigned agents
Retrieves a list of all agents assigned to an application in your organization.
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 number of records to return at once. Limited to 100.
The offset into the records to return.
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
When true, includes each agent's provisioning sync status for this application in the syncStatus and externalId fields.
Headers
Organization identifier that can be obtained from console settings.
Response
OK
Changes
No recorded changes to this operation across all 1 revision of this API.