GET /api/v1/devices
Lists all devices with pagination support.
You can return a subset of Devices that match a supported search criteria using the search query parameter.
Searches for devices based on the properties specified in the search parameter conforming SCIM filter specifications (case-insensitive). This data is eventually consistent. The API returns different results depending on specified queries in the request. Empty list is returned if no objects match search request.
Note: Listing devices with
searchshould not be used as a part of any critical flows—such as authentication or updates—to prevent potential data loss.searchresults may not reflect the latest information, as this endpoint uses a search index which may not be up-to-date with recent updates to the object.
Don't use search results directly for record updates, as the data might be stale and therefore overwrite newer data, resulting in data loss.
Use anidlookup for records that you update to ensure your results contain the latest data. This operation requires URL encoding. For example,search=profile.displayName eq "Bob"is encoded assearch=profile.displayName%20eq%20%22Bob%22.
Servers
- https://{yourOktaDomain}
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
limit |
Integer | No |
A limit on the number of objects to return (recommend Default value: 200 |
after |
String | No | |
search |
String | No |
A SCIM filter expression that filters the results. Searches include all Device |
expand |
String | No |
Includes associated user details and management status for the device in the Possible values:
|
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.