# Kandji

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

App · 20 actions. Web page: https://docs.lodol.com/docs/integrations/kandji

## Actions

### Create device note

Create device note.

**Inputs**

- Device (`device_id`, text, required): Device id.
- Content (`content`, text, required): The text of the device note.

**Outputs**: Result.

- `data` (object): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {
    "author": "",
    "content": "",
    "created_at": "",
    "note_id": "",
    "updated_at": ""
  },
  "has_more": false,
  "next_cursor": null
}
```

### Delete device note

Delete device note.

**Inputs**

- Device (`device_id`, text, required): Device id.
- Note id (`note_id`, text, required): Note id.

**Outputs**: Result.

- `data` (object): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {
    "deleted_at": "",
    "note_id": ""
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get blueprint

Get blueprint.

**Inputs**

- Blueprint (`blueprint_id`, text, required): Blueprint id.

**Outputs**: Result.

- `data` (object): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```

### Get device

Get device.

**Inputs**

- Device (`device_id`, text, required): Device id.

**Outputs**: Result.

- `data` (object): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "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**

- Device (`device_id`, text, required): Device id.
- Limit (`limit`, number): 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.
- Offset (`offset`, number): Specify the starting record to return. From 0 to 2147483647.

**Outputs**: Result.

- `data` (object): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {
    "activity": {},
    "device_id": ""
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get device apps

Get device apps.

**Inputs**

- Device (`device_id`, text, required): Device id.

**Outputs**: Result.

- `data` (object): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {
    "apps": [],
    "device_id": ""
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get device details

Get device details.

**Inputs**

- Device (`device_id`, text, required): Device id.

**Outputs**: Result.

- `data` (object): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```

### Get device note

Get device note.

**Inputs**

- Device (`device_id`, text, required): Device id.
- Note id (`note_id`, text, required): Note id.

**Outputs**: Result.

- `data` (object): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {
    "author": "",
    "content": "",
    "created_at": "",
    "note_id": "",
    "updated_at": ""
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get device status

Get device status.

**Inputs**

- Device (`device_id`, text, required): Device id.

**Outputs**: Result.

- `data` (object): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {
    "device_id": "",
    "library_items": [],
    "parameters": []
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get user

Get user.

**Inputs**

- User (`record_user_id`, text, required): User id.

**Outputs**: Result.

- `data` (object): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "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**

- Name (`name`, text): Return Blueprint names "containing" the specified search string.
- Limit (`limit`, number): Number of results to return per page. From 1 to 300.
- Offset (`offset`, number): The initial index from which to return the results. From 0 to 2147483647.

**Outputs**: Result.

- `data` (object): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {
    "count": "",
    "next": "",
    "previous": "",
    "results": []
  },
  "has_more": false,
  "next_cursor": null
}
```

### List custom apps

List custom apps.

**Inputs**

- Next page URL (`next_page`, text): The continuation URL from the previous result. Leave empty for the first page.

**Outputs**: Result.

- `data` (object): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {
    "count": "",
    "next": "",
    "previous": "",
    "results": []
  },
  "has_more": false,
  "next_cursor": null
}
```

### List custom profiles

List custom profiles.

**Inputs**

- Next page URL (`next_page`, text): The continuation URL from the previous result. Leave empty for the first page.

**Outputs**: Result.

- `data` (object): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {
    "count": "",
    "next": "",
    "previous": "",
    "results": []
  },
  "has_more": false,
  "next_cursor": null
}
```

### List custom scripts

List custom scripts.

**Inputs**

- Next page URL (`next_page`, text): The continuation URL from the previous result. Leave empty for the first page.

**Outputs**: Result.

- `data` (object): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {
    "count": "",
    "next": "",
    "previous": "",
    "results": []
  },
  "has_more": false,
  "next_cursor": null
}
```

### List device notes

List device notes.

**Inputs**

- Device (`device_id`, text, required): Device id.

**Outputs**: Result.

- `data` (list): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}
```

### List devices

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

**Inputs**

- Blueprint (`blueprint_id`, text): Return results "containing" the specified blueprint id
- Device name (`device_name`, text): device_name.
- Limit (`limit`, number): 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.
- Offset (`offset`, number): Specify the starting record to return. From 0 to 2147483647.

**Outputs**: Result.

- `data` (list): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}
```

### List tags

List tags.

**Inputs**

- Search (`search`, text): Return resultes containing a given tag search string.
- Next page URL (`next_page`, text): The continuation URL from the previous result. Leave empty for the first page.

**Outputs**: Result.

- `data` (object): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "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**

- Email (`email`, text): Returns users with email addresses containing the provided string.
- Archived (`archived`, true/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.
- Cursor (`cursor`, text): 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 page (`size_per_page`, number): 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.

- `data` (object): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {
    "next": "",
    "previous": "",
    "results": []
  },
  "has_more": false,
  "next_cursor": null
}
```

### Update device

Update device.

**Inputs**

- Device (`device_id`, text, required): Device id.
- Asset tag (`asset_tag`, text): Asset tag.
- Blueprint (`blueprint_id`, text): Blueprint id.
- User (`user`, text): Directory user UUID.
- Tags (`tags`, list): Tags.

**Outputs**: Result.

- `data` (object): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "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**

- Device (`device_id`, text, required): Device id.
- Note id (`note_id`, text, required): Note id.
- Content (`content`, text, required): The text of the device note.

**Outputs**: Result.

- `data` (object): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {
    "author": "",
    "content": "",
    "created_at": "",
    "note_id": "",
    "updated_at": ""
  },
  "has_more": false,
  "next_cursor": null
}
```
