Get information about the organization including name, unique name, status, system language, etc.

Get a list of devices for an organization using advanced search and filtering.

Key Features

• Combine query parameters (pagination, sorting) with body parameters (filtering)

• Support for text search, field-specific filters, and complex queries

• Pagination with cursor-based navigation

Example Usage

Find first 5 devices for user with email "someone@gmail.com":

• Query: limit=5

• Body: {"searchTerm": "someone@gmail.com", "searchFields": ["people.primaryEmail"]}

Pro Tips

• 1: Always make sure understand the definition of the fields (preset and custom fields) before using them.

• 2: If user search devices by category: pc, phone or other, please use body.type to filter devices by category.

• 3: Always to understand what are current sub types of the devices. If the user search information relate to sub types, Please use body.filters.["preset.subtype"] to filter devices by sub types.

• 4: We don't really need to use searchFields parameter to the search results in all fields, only use it when the user search information relate to specific fields.

• 5: If user want to filter devices by status, please use body.filters.["preset.status"].eq to filter devices by status.

• 5.1: Unassigned devices status should be "in_stock" or "decommissioned".

• 6: If user want to filter devices by preset fields or custom fields, please check the field.kind first, we only support date, number, dropdown kind of fields.

• 6.1: If the field.kind is date, please use body.filters.["preset.field_name"].minDate or body.filters.["custom.attributeCode"].minDate and body.filters.["preset.field_name"].maxDate or body.filters.["custom.attributeCode"].maxDate to filter devices by date range.

• 6.2: If the field.kind is number, please use body.filters.["preset.field_name"].minNumber or body.filters.["custom.attributeCode"].minNumber and body.filters.["preset.field_name"].maxNumber or body.filters.["custom.attributeCode"].maxNumber to filter devices by number range.

• 6.3: If the preset field field.kind is dropdown, please use body.filters.["preset.field_name"].eq or body.filters.["custom.attributeCode"].eq to filter devices by dropdown value.

• 7: Combine multiple filters examples: {"preset.status":{"eq":"active"},"preset.subtype":{"eq":"desktop_pc"},"custom.custom_xxx":{"eq":"1"},"custom.dt_13":{"minDate":"2025-12-23","maxDate":"2025-12-25"},"custom.drp_4":{"eq":"1"}}

Create a new device for an organization. Requires device type (subtype), asset number, and model name. Can include optional preset fields and custom fields.

Update an existing device's information. Can update preset fields, custom fields, and device properties. Note: fields.preset.asset_number, fields.preset.subtype, fields.preset.model_name are always required.

Update device's meta information including assignment info (peopleId, status, dates) and location. Use this to assign/unassign devices to people. When unassigned, status should be 'in_stock' or 'decommissioned'. When assigned without status, defaults to 'active'.

Get all custom fields configured for an organization's devices. Returns field definitions, types (text, date, number, dropdown), and configurations.

Create a new custom field for organization devices. Defines a new field that can be used across all devices in the organization.

Update an existing device custom field configuration. Can modify field name, code, visibility for device types, and dropdown configuration.

Delete a device custom field configuration. Removes a custom field definition from the organization.

Return a list of identities. Can be filtered by the status, department and type. Can also search by the email or name by keyword

Create a new identity in the organization. Requires employeeStatus, employeeType, firstName, and lastName. Optional: displayName, primaryEmail, department, jobTitle, employeeId, lifecycle, customFields, manager, etc.

Get a single identity by ID. Optionally expand with customFieldsMetadata.

Update an existing identity. Pass identityId and any fields to update (employeeStatus, employeeType, displayName, primaryEmail, department, jobTitle, customFields, manager, etc.).

Delete an identity by ID. Returns the deleted identity.

Return a list of services, along with the preview of the accounts. Can be searched by the service name by keyword

Return a list of accounts for a specific service. The serviceId can be obtained from the get_services tool. Can be searched by email/name of the account by keyword

Return a list of SaaS accounts belonging to a person. The peopleId can be obtained from the get_identities tool. Can be filtered by role, two-factor authentication, and searched by service name or workspace name

Get identity field configuration of an organization. Returns preset field configurations, field order, available fields, fields metadata, and field details. Optionally pass an identityId to get the effective configuration for a specific identity.

Get configuration for identity fields of a specific identity. Required to filter by a specific identityId to see the effective configuration for that identity.

Get all identity custom fields configured for an organization. Returns field definitions, types (text, date, number, dropdown), and configurations.

Check Identity management type. Use this endpoint to determine the management type for an identity based on email or identityId. Returns the management type (e.g., hr_master, manual, unregistered).

Get identities statistics for an organization. Returns management type counts, HR master integration information, and domain lists. Use this to understand the distribution of identities across different management types and HR systems.

Merge identities in batch. Use this to merge multiple people entities or identity entities. Supports up to 50 merge operations per request. Can merge people entities (by peopleId) or identity entities (by identityId) in a single operation.

Unmerge previously merged identity/people entities. Provide peopleIds, identityIds, or both to unmerge (up to 50 items each).

Bulk update multiple identities in a single request. Provide a list of identity IDs (1-50) and a set of field updates to apply to all of them. All identity update fields are optional.

Get the change history of a specific identity. Returns a paginated list of history records showing field-level changes, action types, sources, and actors.

Toggle the archive flag for an identity. Returns the updated identity with the new archive state.

Toggle the unregistered management type for an identity. Returns the updated identity with the new management type.

Create a new identity custom field for an organization. Defines a new field that can be used across all identities in the organization.

Update an existing identity custom field configuration. Can modify field name and code.

Delete an identity custom field for an organization. Removes a custom field definition from the organization.