> ## 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.

# Amplemarket: Get Users

> List the users in your Amplemarket account, filtered by status, role or email. Includes SDK V2 examples, input constraints, response fields, and Deepline cost.

List the users in your Amplemarket account, filtered by status, role or email.

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

## 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(
  'amplemarket_get_users',
  {
    "page": {
      "size": 1,
      "after": "cursor_123",
      "before": "cursor_123"
    },
    "status": "example",
    "role": "example"
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute amplemarket_get_users --input '{
  "page": {
    "size": 1,
    "after": "cursor_123",
    "before": "cursor_123"
  },
  "status": "example",
  "role": "example"
}' --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": {
    "users": [
      {
        "id": "id_123",
        "name": "Example",
        "email": "jane.doe@example.com"
      }
    ],
    "_links": {
      "self": {
        "href": "example"
      }
    }
  }
}
```

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

## Input reference

List users

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.page` | `object` | No | — | Page size. Accepts an integer or a numeric string. Amplemarket types this field inconsistently across operations. |
| `payload.status` | `string` | No | — | Filter by user status |
| `payload.role` | `string` | No | — | Filter by user role |
| `payload.email` | `string` | No | — | Filter by user email |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "List users",
    "properties": {
      "page": {
        "type": "object",
        "description": "Page size. Accepts an integer or a numeric string; Amplemarket types this field inconsistently across operations.",
        "properties": {
          "size": {
            "type": [
              "integer",
              "string"
            ],
            "description": "Page size. Accepts an integer or a numeric string; Amplemarket types this field inconsistently across operations."
          },
          "after": {
            "type": "string",
            "description": "Page after"
          },
          "before": {
            "type": "string",
            "description": "Page before"
          }
        },
        "required": [],
        "additionalProperties": false
      },
      "status": {
        "type": "string",
        "description": "Filter by user status"
      },
      "role": {
        "type": "string",
        "description": "Filter by user role"
      },
      "email": {
        "type": "string",
        "description": "Filter by user email"
      }
    },
    "required": [],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.users` | `array` | No | — | — |
| `result.data.users[].id` | `string` | No | — | — |
| `result.data.users[].name` | `string \| null` | No | — | — |
| `result.data.users[].email` | `string` | No | — | — |
| `result.data.users[].role` | `string` | No | — | — |
| `result.data._links` | `object` | No | — | — |
| `result.data._links.self` | `object` | Yes | — | — |
| `result.data._links.self.href` | `string` | Yes | — | — |
| `result.data._links.prev` | `object` | No | — | — |
| `result.data._links.prev.href` | `string` | Yes | — | — |
| `result.data._links.next` | `object` | No | — | — |
| `result.data._links.next.href` | `string` | 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": {
          "users": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                },
                "name": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "email": {
                  "type": "string"
                },
                "role": {
                  "type": "string"
                }
              },
              "additionalProperties": false
            }
          },
          "_links": {
            "type": "object",
            "properties": {
              "self": {
                "type": "object",
                "properties": {
                  "href": {
                    "type": "string"
                  }
                },
                "required": [
                  "href"
                ],
                "additionalProperties": false
              },
              "prev": {
                "type": "object",
                "properties": {
                  "href": {
                    "type": "string"
                  }
                },
                "required": [
                  "href"
                ],
                "additionalProperties": false
              },
              "next": {
                "type": "object",
                "properties": {
                  "href": {
                    "type": "string"
                  }
                },
                "required": [
                  "href"
                ],
                "additionalProperties": false
              }
            },
            "required": [
              "self"
            ],
            "additionalProperties": false
          }
        },
        "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

* [Amplemarket provider guide](https://deepline.com/docs/providers/amplemarket/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.