# Highspot

> Find and read your Highspot sales content: spots, items, search, users, groups and pitches, and start workflows when content is added or changed in a spot.

App · 15 actions. Web page: https://docs.lodol.com/docs/integrations/highspot

## Actions

### Get API user

Get the Highspot user the API key belongs to, whose access the other steps use.

**Inputs**: None.

**Outputs**

- `user` (object): The API key's user

**Example output**

```json
{
  "user": {
    "email": "jo@example.com",
    "id": "5f1e2d3c4b5a69788796a5b4"
  }
}
```

### Get group

Get one Highspot group.

**Inputs**

- Group (`group_id`, text, required): The group. Pick one, or give its id.

**Outputs**

- `group` (object): The group

**Example output**

```json
{
  "group": {
    "id": "5e7d6c5b4a3f2e1d0c9b8a7f"
  }
}
```

### Get item

Get one content item with its title, description, type, file name, spot, author, link and dates.

**Inputs**

- Item ID (`item_id`, text, required): The item's id, from 'List items', 'Search items' or a trigger.

**Outputs**

- `item` (object): The item

**Example output**

```json
{
  "item": {
    "author": "Jo Bloggs",
    "available_at": "",
    "can_download": true,
    "content_name": "pricing-2026.pdf",
    "content_type": "PDF",
    "date_added": "2026-03-02T17:04:11Z",
    "date_original_added": "2026-03-02T17:04:11Z",
    "date_updated": "2026-03-09T08:30:00Z",
    "description": "List prices and discounts for the 2026 plans.",
    "description_external": "Our plans and what each includes.",
    "expires_at": "",
    "id": "6a1b2c3d4e5f60718293a4b5",
    "imported_at": "",
    "internal": true,
    "language": "en",
    "mime_type": "application/pdf",
    "spot": "5d6c4b3a2f1e0d9c8b7a6f5e",
    "title": "2026 pricing one-pager",
    "title_external": "Pricing overview",
    "url": "https://app.highspot.com/items/6a1b2c3d4e5f60718293a4b5"
  }
}
```

### Get item content-system metadata

Get the metadata an item carries from the content system it is synced from, such as SharePoint or Google Drive.

**Inputs**

- Item ID (`item_id`, text, required): The item's id, from 'List items', 'Search items' or a trigger.

**Outputs**

- `item_id` (text): The id that was asked about
- `metadata` (object): The content system's metadata, as Highspot gives it

**Example output**

```json
{
  "item_id": "6a1b2c3d4e5f60718293a4b5",
  "metadata": {
    "path": "/Sales/pricing.pdf",
    "source": "sharepoint"
  }
}
```

### Get item properties

Get an item's custom properties, the extra fields your company adds to content, or one of them by name.

**Inputs**

- Item ID (`item_id`, text, required): The item's id, from 'List items', 'Search items' or a trigger.
- Property name (`property_name`, text): Only this one of the item's custom properties. Leave empty for all of them.

**Outputs**

- `item_id` (text): The id that was asked about
- `properties` (object): The custom properties, by name, as Highspot gives them. One property asked for by name is kept under that name

**Example output**

```json
{
  "item_id": "6a1b2c3d4e5f60718293a4b5",
  "properties": {
    "product_line": "Platform",
    "region": "EMEA"
  }
}
```

### Get spot

Get one spot with its title and details.

**Inputs**

- Spot (`spot_id`, text, required): The spot. Pick one, or give its id.

**Outputs**

- `spot` (object): The spot

**Example output**

```json
{
  "spot": {
    "id": "5d6c4b3a2f1e0d9c8b7a6f5e",
    "title": "Sales plays"
  }
}
```

### Get user

Get one Highspot user.

**Inputs**

- User (`user`, text, required): The user. Pick one, or give their id.

**Outputs**

- `user` (object): The user

**Example output**

```json
{
  "user": {
    "email": "jo@example.com",
    "id": "5f1e2d3c4b5a69788796a5b4"
  }
}
```

### Get user properties

Get a user's custom properties, such as their region or team, or one of them by name.

**Inputs**

- User (`user`, text, required): The user. Pick one, or give their id.
- Property name (`property_name`, text): Only this one of the user's custom properties. Leave empty for all of them.

**Outputs**

- `properties` (object): The custom properties, by name, as Highspot gives them. One property asked for by name is kept under that name
- `user_id` (text): The id that was asked about

**Example output**

```json
{
  "properties": {
    "department": "Sales",
    "region": "EMEA"
  },
  "user_id": "5f1e2d3c4b5a69788796a5b4"
}
```

### List groups

List your company's Highspot groups, optionally only those where you have a role or right. Gets one page; to see more, run it again from the next start it gives.

**Inputs**

- Your role (`role`, text): Only groups where you have this role. One of: `owner`, `manager`, `editor`, `viewer`.
- Your right (`right`, text): Only groups where you have this right. One of: `manage`, `edit`, `view`.
- Start at (`start`, number): Where to start, from 0. Use the 'next_start' an earlier run gave to read on. At least 0.
- Page size (`limit`, number): How many to return, 1 to 100. Defaults to 25. From 1 to 100.

**Outputs**

- `count` (number): How many came back on this page
- `groups` (list): The groups
- `has_more` (true/false): True if this page was full, so there may be more
- `next_start` (number): The start to ask for next, or 0 when this page was not full and there are no more
- `start` (number): Where this page started, from 0

**Example output**

```json
{
  "count": 1,
  "groups": [
    {
      "id": "5e7d6c5b4a3f2e1d0c9b8a7f"
    }
  ],
  "has_more": false,
  "next_start": 0,
  "start": 0
}
```

### List item bookmarks

List the bookmarks of an item: the copies of it placed in other spots.

**Inputs**

- Item ID (`item_id`, text, required): The item's id, from 'List items', 'Search items' or a trigger.

**Outputs**

- `bookmarks` (list): The item's bookmarks
- `count` (number): How many bookmarks
- `item_id` (text): The id that was asked about

**Example output**

```json
{
  "bookmarks": [
    {
      "author": "Jo Bloggs",
      "available_at": "",
      "can_download": true,
      "content_name": "pricing-2026.pdf",
      "content_type": "PDF",
      "date_added": "2026-03-02T17:04:11Z",
      "date_original_added": "2026-03-02T17:04:11Z",
      "date_updated": "2026-03-09T08:30:00Z",
      "description": "List prices and discounts for the 2026 plans.",
      "description_external": "Our plans and what each includes.",
      "expires_at": "",
      "id": "6b2c3d4e5f60718293a4b5c6",
      "imported_at": "",
      "internal": true,
      "language": "en",
      "mime_type": "application/pdf",
      "spot": "5d6c",
      "title": "2026 pricing one-pager",
      "title_external": "Pricing overview",
      "url": "https://app.highspot.com/items/6a1b2c3d4e5f60718293a4b5"
    }
  ],
  "count": 1,
  "item_id": "6a1b2c3d4e5f60718293a4b5"
}
```

### List items

List the content items in a spot, or in one of its lists, with their title, type, link and dates. Gets one page; to see more, run it again from the next start it gives.

**Inputs**

- Spot (`spot_id`, text, required): The spot. Pick one, or give its id.
- List ID (`list_id`, text): Only the items in this list of the spot, by its id. Leave empty for the whole spot.
- Act as (`act_as`, text): The email of a Highspot user to act as, to see what they see. Needs API impersonation, which Highspot support turns on for an API key. Leave empty to use the access of the user who made the key.
- Start at (`start`, number): Where to start, from 0. Use the 'next_start' an earlier run gave to read on. At least 0.
- Page size (`limit`, number): How many to return, 1 to 100. Defaults to 25. From 1 to 100.

**Outputs**

- `count` (number): How many came back on this page
- `has_more` (true/false): True if this page was full, so there may be more
- `items` (list): The items
- `next_start` (number): The start to ask for next, or 0 when this page was not full and there are no more
- `start` (number): Where this page started, from 0

**Example output**

```json
{
  "count": 1,
  "has_more": false,
  "items": [
    {
      "author": "Jo Bloggs",
      "available_at": "",
      "can_download": true,
      "content_name": "pricing-2026.pdf",
      "content_type": "PDF",
      "date_added": "2026-03-02T17:04:11Z",
      "date_original_added": "2026-03-02T17:04:11Z",
      "date_updated": "2026-03-09T08:30:00Z",
      "description": "List prices and discounts for the 2026 plans.",
      "description_external": "Our plans and what each includes.",
      "expires_at": "",
      "id": "6a1b2c3d4e5f60718293a4b5",
      "imported_at": "",
      "internal": true,
      "language": "en",
      "mime_type": "application/pdf",
      "spot": "5d6c4b3a2f1e0d9c8b7a6f5e",
      "title": "2026 pricing one-pager",
      "title_external": "Pricing overview",
      "url": "https://app.highspot.com/items/6a1b2c3d4e5f60718293a4b5"
    }
  ],
  "next_start": 0,
  "start": 0
}
```

### List pitches

List the pitches (content sent to buyers) you have sent, by recent activity, newest first or name. Gets one page; to see more, run it again from the next start it gives.

**Inputs**

- Order (`sort_by`, text): How to order them. Defaults to recent activity. One of: `recent_activity` (Recent activity (default)), `date_created` (Newest first), `alphabetical`.
- Act as (`act_as`, text): The email of a Highspot user to act as, to see what they see. Needs API impersonation, which Highspot support turns on for an API key. Leave empty to use the access of the user who made the key.
- Start at (`start`, number): Where to start, from 0. Use the 'next_start' an earlier run gave to read on. At least 0.
- Page size (`limit`, number): How many to return, 1 to 100. Defaults to 25. From 1 to 100.

**Outputs**

- `count` (number): How many came back on this page
- `has_more` (true/false): True if this page was full, so there may be more
- `next_start` (number): The start to ask for next, or 0 when this page was not full and there are no more
- `pitches` (list): The pitches
- `start` (number): Where this page started, from 0

**Example output**

```json
{
  "count": 1,
  "has_more": false,
  "next_start": 0,
  "pitches": [
    {
      "id": "60a1b2c3d4e5f60718293a4c"
    }
  ],
  "start": 0
}
```

### List spots

List the spots (Highspot's content collections) you can view. Gets one page; to see more, run it again from the next start it gives.

**Inputs**

- Act as (`act_as`, text): The email of a Highspot user to act as, to see what they see. Needs API impersonation, which Highspot support turns on for an API key. Leave empty to use the access of the user who made the key.
- Start at (`start`, number): Where to start, from 0. Use the 'next_start' an earlier run gave to read on. At least 0.
- Page size (`limit`, number): How many to return, 1 to 100. Defaults to 25. From 1 to 100.

**Outputs**

- `count` (number): How many came back on this page
- `has_more` (true/false): True if this page was full, so there may be more
- `next_start` (number): The start to ask for next, or 0 when this page was not full and there are no more
- `spots` (list): The spots
- `start` (number): Where this page started, from 0

**Example output**

```json
{
  "count": 1,
  "has_more": false,
  "next_start": 0,
  "spots": [
    {
      "id": "5d6c4b3a2f1e0d9c8b7a6f5e",
      "title": "Sales plays"
    }
  ],
  "start": 0
}
```

### List users

List your company's Highspot users, or find one by email. Gets one page; to see more, run it again from the next start it gives.

**Inputs**

- Email (`email`, text): Only the user with this email address.
- Which users (`status`, text): Verified users, who have signed in, unverified ones, or all. Defaults to verified. One of: `verified` (Verified users (default)), `unverified` (Unverified users), `all` (All users).
- Start at (`start`, number): Where to start, from 0. Use the 'next_start' an earlier run gave to read on. At least 0.
- Page size (`limit`, number): How many to return, 1 to 100. Defaults to 25. From 1 to 100.

**Outputs**

- `count` (number): How many came back on this page
- `has_more` (true/false): True if this page was full, so there may be more
- `next_start` (number): The start to ask for next, or 0 when this page was not full and there are no more
- `start` (number): Where this page started, from 0
- `users` (list): The users

**Example output**

```json
{
  "count": 1,
  "has_more": false,
  "next_start": 0,
  "start": 0,
  "users": [
    {
      "email": "jo@example.com",
      "id": "5f1e2d3c4b5a69788796a5b4"
    }
  ]
}
```

### Search items

Search the content in every spot you can view, by best match or newest first. Gets one page; to see more, run it again from the next start it gives.

**Inputs**

- Search for (`query`, text, required): The words to search for, as in Highspot's search box.
- Order (`sort_by`, text): Best match or newest first. Defaults to best match. One of: `relevancy` (Best match (default)), `date_added` (Newest first).
- Act as (`act_as`, text): The email of a Highspot user to act as, to see what they see. Needs API impersonation, which Highspot support turns on for an API key. Leave empty to use the access of the user who made the key.
- Start at (`start`, number): Where to start, from 0. Use the 'next_start' an earlier run gave to read on. At least 0.
- Page size (`limit`, number): How many to return, 1 to 100. Defaults to 25. From 1 to 100.

**Outputs**

- `count` (number): How many came back on this page
- `has_more` (true/false): True if this page was full, so there may be more
- `items` (list): The matching items
- `next_start` (number): The start to ask for next, or 0 when this page was not full and there are no more
- `start` (number): Where this page started, from 0

**Example output**

```json
{
  "count": 1,
  "has_more": false,
  "items": [
    {
      "author": "Jo Bloggs",
      "available_at": "",
      "can_download": true,
      "content_name": "pricing-2026.pdf",
      "content_type": "PDF",
      "date_added": "2026-03-02T17:04:11Z",
      "date_original_added": "2026-03-02T17:04:11Z",
      "date_updated": "2026-03-09T08:30:00Z",
      "description": "List prices and discounts for the 2026 plans.",
      "description_external": "Our plans and what each includes.",
      "expires_at": "",
      "id": "6a1b2c3d4e5f60718293a4b5",
      "imported_at": "",
      "internal": true,
      "language": "en",
      "mime_type": "application/pdf",
      "spot": "5d6c4b3a2f1e0d9c8b7a6f5e",
      "title": "2026 pricing one-pager",
      "title_external": "Pricing overview",
      "url": "https://app.highspot.com/items/6a1b2c3d4e5f60718293a4b5"
    }
  ],
  "next_start": 0,
  "start": 0
}
```
