---
title: "List the PhantomBuster phantom ids, by group"
method: GET
path: "/api/phantombuster-monitor/agents"
tags: ["PhantomBuster monitor"]
---

# List the PhantomBuster phantom ids, by group

`GET /api/phantombuster-monitor/agents`

## Request

- Base URL: `https://api.sponsorunited.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.sponsorunited.com/api/phantombuster-monitor/agents`
- Auth: HTTP bearer

Returns every phantom id in the phantombuster-agent-ids system setting, so the schema-change monitor does not keep its own list. Read without the cache, so a change to the setting shows up on the next call. A group missing from the setting comes back with an empty list. Ids are strings because some are larger than JavaScript can hold exactly as a number. Requires the phantombuster-monitor-read permission.

## Response `200`

The phantom ids of each group

- object
  - `groups` object[], required
    - `group` 'linkedin.visitor' | 'linkedin.search' | 'linkedin.ondemand' | 'linkedin.company' | 'linkedin.scraper' | 'facebook', required
    - `agentIds` string[], required

## Other responses

- `401`: No valid token
- `403`: Caller lacks the phantombuster-monitor-read permission

---

[API](https://skmtc.dev/sponsorunited/apis/sponsorunited-api.md) - [All operations](https://skmtc.dev/sponsorunited/apis/sponsorunited-api/llms.txt) - [OpenAPI document](https://skmtc.dev/sponsorunited/apis/sponsorunited-api/revisions/cbf1ca5bff8f?raw)