Kandji

App · 20 actions

Read device inventory, Blueprints and directory users, update device assignments, and manage device notes.

Actions

ActionWhat it does
Create device noteCreate device note.
Delete device noteDelete device note.
Get blueprintGet blueprint.
Get deviceGet device.
Get device activityGet device activity.
Get device appsGet device apps.
Get device detailsGet device details.
Get device noteGet device note.
Get device statusGet device status.
Get userGet user.
List blueprintsList blueprints.
List custom appsList custom apps.
List custom profilesList custom profiles.
List custom scriptsList custom scripts.
List device notesList device notes.
List devicesList devices.
List tagsList tags.
List usersList users.
Update deviceUpdate device.
Update device noteUpdate device note.

Create device note

Create device note.

Inputs

Devicedevice_idtextRequired
Device id.
ContentcontenttextRequired
The text of the device note.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "author": "",
    "content": "",
    "created_at": "",
    "note_id": "",
    "updated_at": ""
  },
  "has_more": false,
  "next_cursor": null
}

Delete device note

Delete device note.

Inputs

Devicedevice_idtextRequired
Device id.
Note idnote_idtextRequired
Note id.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "deleted_at": "",
    "note_id": ""
  },
  "has_more": false,
  "next_cursor": null
}

Get blueprint

Get blueprint.

Inputs

Blueprintblueprint_idtextRequired
Blueprint id.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

Get device

Get device.

Inputs

Devicedevice_idtextRequired
Device id.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "agent_installed": "",
    "agent_version": "",
    "asset_tag": "",
    "blueprint_id": "",
    "blueprint_name": "",
    "device_id": "",
    "device_name": "",
    "first_enrollment": "",
    "is_missing": "",
    "is_removed": "",
    "last_check_in": "",
    "last_enrollment": "",
    "mdm_enabled": "",
    "model": "",
    "os_version": "",
    "platform": "",
    "serial_number": "",
    "supplemental_build_version": "",
    "supplemental_os_version_extra": "",
    "tags": [],
    "user": {}
  },
  "has_more": false,
  "next_cursor": null
}

Get device activity

Get device activity.

Inputs

Devicedevice_idtextRequired
Device id.
Limitlimitnumber
A hard upper limit is set at 300 device records returned per request. If more device records are expected, pagination should be used using the limit and offset parameters. Additionally, parameter queries can be added to a request to limit the results.From 1 to 300.
Offsetoffsetnumber
Specify the starting record to returnFrom 0 to 2147483647.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "activity": {},
    "device_id": ""
  },
  "has_more": false,
  "next_cursor": null
}

Get device apps

Get device apps.

Inputs

Devicedevice_idtextRequired
Device id.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "apps": [],
    "device_id": ""
  },
  "has_more": false,
  "next_cursor": null
}

Get device details

Get device details.

Inputs

Devicedevice_idtextRequired
Device id.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

Get device note

Get device note.

Inputs

Devicedevice_idtextRequired
Device id.
Note idnote_idtextRequired
Note id.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "author": "",
    "content": "",
    "created_at": "",
    "note_id": "",
    "updated_at": ""
  },
  "has_more": false,
  "next_cursor": null
}

Get device status

Get device status.

Inputs

Devicedevice_idtextRequired
Device id.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "device_id": "",
    "library_items": [],
    "parameters": []
  },
  "has_more": false,
  "next_cursor": null
}

Get user

Get user.

Inputs

Userrecord_user_idtextRequired
User id.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "active": "",
    "archived": "",
    "created_at": "",
    "department": "",
    "deprecated_user_id": "",
    "device_count": "",
    "email": "",
    "id": "",
    "integration": {},
    "job_title": "",
    "name": "",
    "updated_at": ""
  },
  "has_more": false,
  "next_cursor": null
}

List blueprints

List blueprints. Returns one page; use the continuation value for more records.

Inputs

Namenametext
Return Blueprint names "containing" the specified search string.
Limitlimitnumber
Number of results to return per page.From 1 to 300.
Offsetoffsetnumber
The initial index from which to return the results.From 0 to 2147483647.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "count": "",
    "next": "",
    "previous": "",
    "results": []
  },
  "has_more": false,
  "next_cursor": null
}

List custom apps

List custom apps.

Inputs

Next page URLnext_pagetext
The continuation URL from the previous result. Leave empty for the first page.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "count": "",
    "next": "",
    "previous": "",
    "results": []
  },
  "has_more": false,
  "next_cursor": null
}

List custom profiles

List custom profiles.

Inputs

Next page URLnext_pagetext
The continuation URL from the previous result. Leave empty for the first page.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "count": "",
    "next": "",
    "previous": "",
    "results": []
  },
  "has_more": false,
  "next_cursor": null
}

List custom scripts

List custom scripts.

Inputs

Next page URLnext_pagetext
The continuation URL from the previous result. Leave empty for the first page.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "count": "",
    "next": "",
    "previous": "",
    "results": []
  },
  "has_more": false,
  "next_cursor": null
}

List device notes

List device notes.

Inputs

Devicedevice_idtextRequired
Device id.

Outputs

Result.

datalist
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}

List devices

List devices. Returns one page; use the continuation value for more records.

Inputs

Blueprintblueprint_idtext
Return results "containing" the specified blueprint id
Device namedevice_nametext
device_name.
Limitlimitnumber
A hard upper limit is set at 300 device records returned per request. If more device records are expected, pagination should be used using the limit and offset parameters. Additionally, parameter queries can be added to a request to limit the results.From 1 to 300.
Offsetoffsetnumber
Specify the starting record to returnFrom 0 to 2147483647.

Outputs

Result.

datalist
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}

List tags

List tags.

Inputs

Searchsearchtext
Return resultes containing a given tag search string.
Next page URLnext_pagetext
The continuation URL from the previous result. Leave empty for the first page.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "count": "",
    "next": "",
    "previous": "",
    "results": []
  },
  "has_more": false,
  "next_cursor": null
}

List users

List users. Returns one page; use the continuation value for more records.

Inputs

Emailemailtext
Returns users with email addresses containing the provided string.
Archivedarchivedtrue/false
Return only users that are either archived (true) or not archived (false). Archived users are users that appear in the Users module under the Archived tab.
Cursorcursortext
Cursor for the next or previous page of results. Can also store the URL in the next and previous fields in the response.
Size per pagesize_per_pagenumber
Adjusts the number of records to return per page for large data sets. Defaults to 25, supports a maximum number of 300 records per page.From 1 to 300.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "next": "",
    "previous": "",
    "results": []
  },
  "has_more": false,
  "next_cursor": null
}

Update device

Update device.

Inputs

Devicedevice_idtextRequired
Device id.
Asset tagasset_tagtext
Asset tag.
Blueprintblueprint_idtext
Blueprint id.
Userusertext
Directory user UUID.
Tagstagslist
Tags.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "agent_installed": "",
    "agent_version": "",
    "asset_tag": "",
    "blueprint_id": "",
    "blueprint_name": "",
    "device_id": "",
    "device_name": "",
    "first_enrollment": "",
    "is_missing": "",
    "is_removed": "",
    "last_check_in": "",
    "last_enrollment": "",
    "mdm_enabled": "",
    "model": "",
    "os_version": "",
    "platform": "",
    "serial_number": "",
    "tags": [],
    "user": {}
  },
  "has_more": false,
  "next_cursor": null
}

Update device note

Update device note.

Inputs

Devicedevice_idtextRequired
Device id.
Note idnote_idtextRequired
Note id.
ContentcontenttextRequired
The text of the device note.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "author": "",
    "content": "",
    "created_at": "",
    "note_id": "",
    "updated_at": ""
  },
  "has_more": false,
  "next_cursor": null
}

On this page