> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Unipile: List Followers

> List the followers of the connected account owner. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

List the followers of the connected account owner.

> [!NOTE]
>
> Tool ID: `unipile_list_followers`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'unipile_list_followers',
  {
    "account_id": "123456789"
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute unipile_list_followers --input '{
  "account_id": "123456789"
}' --json
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "data": {
    "object": "UserFollowersList",
    "items": [
      {
        "object": "UserFollower",
        "id": "id_123",
        "urn": "example",
        "name": "Example",
        "headline": "example",
        "profile_url": "https://example.com",
        "profile_picture_url": "https://example.com",
        "profile_picture_url_large": "https://example.com"
      }
    ],
    "cursor": "cursor_123"
  }
}
```

Use `deepline describe unipile_list_followers --json` for the latest machine-readable contract.

## Input reference

Returns a list of all the followers of the current user. Ensure careful implementation of this action and consult provider limits and restrictions: [https://developer.unipile.com/docs/provider-limits-and-restrictions](https://developer.unipile.com/docs/provider-limits-and-restrictions)

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.user_id` | `string` | No | — | `Instagram` The user to get the followers from (provider\_id or username). `Linkedin` The user or company to get the followers from (provider\_id only). |
| `payload.cursor` | `string` | No | — | A cursor for pagination purposes. To get the next page of entries, you need to make a new request and fulfill this field with the cursor received in the preceding request. This process should be repeated until all entries have been retrieved. Minimum length: 1. |
| `payload.limit` | `integer` | No | — | A limit for the number of items returned in the response. `Linkedin` 100 max for own profile, 50 for other profile `Instagram` 25 max. `Instagram` This is a ceiling, not a guarantee: Instagram may return fewer items than requested for a given page (its own pagination internals can occasionally short a page), and for `Verified` target accounts it returns only a small fixed sample and closes the cursor immediately regardless of the value requested. Minimum: 1. Maximum: 250. |
| `payload.account_id` | `string` | Yes | — | The account to get the followers from. (if user\_id is not provided) |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Returns a list of all the followers of the current user. Ensure careful implementation of this action and consult provider limits and restrictions: https://developer.unipile.com/docs/provider-limits-and-restrictions",
    "properties": {
      "user_id": {
        "type": "string",
        "description": "`Instagram` The user to get the followers from (provider_id or username). `Linkedin` The user or company to get the followers from (provider_id only)."
      },
      "cursor": {
        "type": "string",
        "description": "A cursor for pagination purposes. To get the next page of entries, you need to make a new request and fulfill this field with the cursor received in the preceding request. This process should be repeated until all entries have been retrieved.",
        "minLength": 1
      },
      "limit": {
        "type": "integer",
        "description": "A limit for the number of items returned in the response. `Linkedin` 100 max for own profile, 50 for other profile `Instagram` 25 max. `Instagram` This is a ceiling, not a guarantee: Instagram may return fewer items than requested for a given page (its own pagination internals can occasionally short a page), and for `Verified` target accounts it returns only a small fixed sample and closes the cursor immediately regardless of the value requested.",
        "minimum": 1,
        "maximum": 250
      },
      "account_id": {
        "type": "string",
        "description": "The account to get the followers from. (if user_id is not provided)"
      }
    },
    "required": [
      "account_id"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.object` | `"UserFollowersList"` | Yes | — | Allowed: `UserFollowersList`. |
| `result.data.items` | `array` | Yes | — | — |
| `result.data.items[].object` | `"UserFollower"` | Yes | — | — |
| `result.data.items[].id` | `string` | Yes | — | — |
| `result.data.items[].urn` | `string` | Yes | — | — |
| `result.data.items[].name` | `string` | Yes | — | — |
| `result.data.items[].headline` | `string` | Yes | — | — |
| `result.data.items[].profile_url` | `string` | Yes | — | — |
| `result.data.items[].profile_picture_url` | `string \| null` | Yes | — | — |
| `result.data.items[].profile_picture_url_large` | `string \| null` | Yes | — | — |
| `result.data.items[].messaging_id` | `string` | Yes | — | Deprecated: kept for backward compatibility only. This field is not available anymore for Instagram followers and will always be an empty string. |
| `result.data.items[].username` | `string` | Yes | — | — |
| `result.data.items[].is_private` | `boolean` | Yes | — | — |
| `result.data.items[].is_verified` | `boolean` | Yes | — | — |
| `result.data.cursor` | `unknown \| null` | Yes | — | — |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Provider response payload.",
        "properties": {
          "object": {
            "type": "string",
            "enum": [
              "UserFollowersList"
            ]
          },
          "items": {
            "type": "array",
            "items": {
              "anyOf": [
                {
                  "type": "object",
                  "properties": {
                    "object": {
                      "type": "string",
                      "enum": [
                        "UserFollower"
                      ]
                    },
                    "id": {
                      "type": "string"
                    },
                    "urn": {
                      "type": "string"
                    },
                    "name": {
                      "type": "string"
                    },
                    "headline": {
                      "type": "string"
                    },
                    "profile_url": {
                      "type": "string"
                    },
                    "profile_picture_url": {
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "profile_picture_url_large": {
                      "type": [
                        "string",
                        "null"
                      ]
                    }
                  },
                  "required": [
                    "object",
                    "id",
                    "urn",
                    "name",
                    "headline",
                    "profile_url",
                    "profile_picture_url",
                    "profile_picture_url_large"
                  ],
                  "additionalProperties": false
                },
                {
                  "type": "object",
                  "properties": {
                    "object": {
                      "type": "string",
                      "enum": [
                        "UserFollower"
                      ]
                    },
                    "id": {
                      "type": "string"
                    },
                    "messaging_id": {
                      "type": "string",
                      "description": "Deprecated: kept for backward compatibility only. This field is not available anymore for Instagram followers and will always be an empty string."
                    },
                    "username": {
                      "type": "string"
                    },
                    "name": {
                      "type": "string"
                    },
                    "profile_picture_url": {
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "is_private": {
                      "type": "boolean"
                    },
                    "is_verified": {
                      "type": "boolean"
                    }
                  },
                  "required": [
                    "object",
                    "id",
                    "messaging_id",
                    "username",
                    "name",
                    "is_private",
                    "is_verified"
                  ],
                  "additionalProperties": false
                }
              ]
            }
          },
          "cursor": {
            "anyOf": [
              {},
              {
                "type": "null"
              }
            ]
          }
        },
        "required": [
          "object",
          "items",
          "cursor"
        ],
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.

## Related documentation

* [Unipile provider guide](https://deepline.com/docs/providers/unipile/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.