API Reference
  1. Assets API
  2. Assets

Read assets

get
https://develop.dev.itflow.org/api/v1/assets/read.php

Retrieves assets accessible to the authenticated API user.

Supports several mutually exclusive lookup parameters.
The first matching parameter in the following order is used:

  1. client_id
  2. asset_id
  3. asset_type
  4. asset_name
  5. asset_serial
  6. asset_mac
  7. asset_uri
  8. asset_uri_2

If none of these parameters are supplied, the endpoint returns
a paginated list of all assets accessible to the authenticated user.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
≥ 1

Optional client ID to scope the read to a specific client.
This is only used when the authenticated API key has access
to that client.

int64
≥ 1

Retrieve a single asset by its ID.

string

Retrieve assets matching the specified asset type.

string

Retrieve assets matching the exact asset name.

string

Retrieve assets matching the exact serial number.

string

Retrieve assets by the MAC address of their primary interface.

string

Retrieve assets matching the specified URI.

string

Retrieve assets matching the secondary URI.

integer
≥ 0
Defaults to 50

Maximum number of records returned for collection queries.
Defaults to 50.

integer
≥ 0
Defaults to 0

Number of records to skip for collection queries.
Defaults to 0.

Responses

Updated about 6 hours ago

Did this page help you?
Language
Credentials
Query
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 6 hours ago

Did this page help you?