# Get Contacts — MixMax

> Lists all your Mixmax Contacts (ie people you've emailed using Mixmax). Does not currently return contacts shared with you via shared contact groups (a performance limitiation). See the docs here

- Key: `mixmax-get-contacts`
- Type: Action (Read-only)
- Version: 0.0.2
- App: MixMax (`mixmax`) — https://pipedream.com/apps/mixmax.md
- This page (HTML): https://pipedream.com/apps/mixmax/actions/get-contacts
- Hints: read-only · open-world
- Source: https://github.com/PipedreamHQ/pipedream/blob/master/components/mixmax/actions/get-contacts/get-contacts.mjs

## Description

Lists all your Mixmax Contacts (ie people you've emailed using Mixmax). Does not currently return contacts shared with you via shared contact groups (a performance limitiation). [See the docs here](https://developer.mixmax.com/reference/contacts)

## Props

| Prop | Type | Required | Description |
|---|---|---|---|
| `sort` | `string` | No | Sort by this field in order to get a list of results to then return in pages. |
| `sortAscending` | `boolean` | No | True to sort ascending (A-Z). |
| `email` | `string[]` | No | Exact email required. Matches case-insensitively. |
| `name` | `string` | No | Partial match on contact name. Matches case-insensitively. Only one name search operator supported. |
| `groups` | `string[]` | No | Exact, case-sensitive match on group name. If multiple group search operators passed they will be treated as an AND (i.e. contacts returned must be in all groups). Options are loaded from the connected account. |
| `includeShared` | `boolean` | No | True to include contacts shared with you. Can only be used when also using any filters due to current performance limitations. |
| `expand` | `string[]` | No | Fields to expand. |
| `withAnalytics` | `boolean` | No | Include analytics in the response |
| `dates` | `string` | No | A string describing the analytics date range. |
| `limit` | `integer` | No | The number of results you'd like to get back. Defaults to 10. |
| `fields` | `string[]` | No | By default, all APIs return all properties of the response objects. For APIs that return collections, you can have it return only specific fields. |

## Run it

**MCP**

```ts
import { Client } from "@modelcontextprotocol/sdk/client/index.js"
import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp.js"
import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const accessToken = await pd.rawAccessToken

const transport = new StreamableHTTPClientTransport(
  new URL("https://remote.mcp.pipedream.net/v3"),
  {
    requestInit: {
      headers: {
        Authorization: `Bearer ${accessToken}`,
        "x-pd-project-id": process.env.PIPEDREAM_PROJECT_ID!,
        "x-pd-environment": "production",
        "x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
        "x-pd-app-slug": "mixmax",
      },
    },
  },
)

const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)

const { tools } = await mcp.listTools()

// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
  name: "mixmax-get-contacts",
  arguments: {
    sort: "Sort Field",
    sortAscending: true,
  },
})
```

**TypeScript**

```ts
import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "mixmax-get-contacts",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    mixmax: { authProvisionId: "apn_xxxxxxx" },
    sort: "Sort Field",
    sortAscending: true,
  },
})

console.log(result)
```

**cURL**

```bash
curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
  -H "Content-Type: application/json" \
  -H "X-PD-Environment: production" \
  -H "Authorization: Bearer {access_token}" \
  -d '{
    "external_user_id": "{external_user_id}",
    "id": "mixmax-get-contacts",
    "configured_props": {
      "mixmax": { "authProvisionId": "apn_xxxxxxx" },
      "sort": "Sort Field",
      "sortAscending": true
    }
  }'
```

---

- App: https://pipedream.com/apps/mixmax.md · All apps: https://pipedream.com/apps