Search devices for an organization

post

https://api.itmc.i.moneyforward.com/api/v1/organizations/{organizationId}/devices/search

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

organizationId

number

required

Query Params

limit

number

Maximum number of items to return per page

cursor

string

Base64-encoded cursor for pagination. Use the cursor from the previous response to get the next page.

sortBy

string

The sortBy value is a string that contains two parts separated by a dot. The first part is either preset or custom and the second part is the unique field name. Additionally the following fields can be used for sorting: people.displayName.

sortOrder

string

enum

Sort order for the results (asc or desc)

Allowed:

expands

array of objects

Expand other datasets when fetching devices. Accepts multiple options.

expands

Body Params

peopleId

number

Filter devices by the people ID assigned to them

type

string

enum

Filter devices by device type

Allowed:

employeeStatus

string

enum

Filter devices by the employment status of the assigned person

Allowed:

searchTerm

string

Search term to filter devices. Searches across fields specified in searchFields

searchFields

array of strings

Array of field names to search within when using searchTerm. Supports memo, people fields, preset fields, and custom fields

searchFields

filters

object

The object key is the field name, and the value is the filter options. Keys look like preset.<unique field name>. There are certain extra virtual fields, such as $age, please check implementation or ask a backend engineer.

Responses

418

The feature isn't available for the organization. Please contact the support team.

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200