Affinity: V2 Users Get

List the internal users on your Affinity team, with name, emails, status and role.

Tool ID: affinity_v2_users_get

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.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'affinity_v2_users_get',
  {
    "cursor": "cursor_123",
    "limit": 100,
    "term": "software companies hiring engineers"
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute affinity_v2_users_get --input '{
  "cursor": "cursor_123",
  "limit": 100,
  "term": "software companies hiring engineers"
}' --json

Example response

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

{
  "data": {
    "data": [
      {
        "id": 123,
        "firstName": "Jane",
        "lastName": "Doe",
        "primaryEmailAddress": "jane.doe@example.com",
        "photoUrl": "https://example.com",
        "status": "active"
      }
    ],
    "pagination": {
      "prevUrl": "https://example.com",
      "nextUrl": "https://example.com"
    }
  }
}

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

Input reference

| ⚠️ This endpoint is currently in BETA | |—| Paginate through internal Users in your organization. Returns information about each User, including name, primary email address, all email addresses, photo URL, account status, and account role. The emailAddresses and role properties are only returned to callers with the “Manage Users” permission. Use the optional term parameter to filter by first name, last name, or primary email address. You can also filter users using the filter query parameter. The filter parameter is a string that you can specify conditions based on the following properties. | Property Name | Type | Allowed Operators | Examples | |---|---|---|---| | id | int32 | = | id=1\\|id=2\\|id=3 | | status | enum | = | status=active |

Name	Type	Required	Default	Details
`payload.cursor`	`string`	No	—	Cursor for the next or previous page
`payload.limit`	`integer`	No	`100`	Number of items to include in the page Format: `int32`. Minimum: 1. Maximum: 100.
`payload.term`	`string`	No	—	Case-insensitive search across first name, last name, and primary email address. Returns users matching the term as a substring.
`payload.filter`	`string`	No	—	Filter options

Output reference

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	—
`result.data.data`	`array`	Yes	—	Maximum items: 100.
`result.data.data[].id`	`integer`	Yes	—	Format: `int32`. Minimum: 1. Maximum: 2147483647.
`result.data.data[].firstName`	`string`	Yes	—	—
`result.data.data[].lastName`	`string \| null`	Yes	—	—
`result.data.data[].primaryEmailAddress`	`string \| null`	Yes	—	Format: `email`.
`result.data.data[].emailAddresses`	`array`	No	—	Maximum items: 100.
`result.data.data[].photoUrl`	`string \| null`	Yes	—	Format: `uri`.
`result.data.data[].status`	`"active" \| "invited" \| "deactivated"`	Yes	—	Allowed: `active`, `invited`, `deactivated`.
`result.data.data[].role`	`string`	No	—	—
`result.data.pagination`	`object`	Yes	—	—
`result.data.pagination.prevUrl`	`string \| null`	No	—	Format: `uri`.
`result.data.pagination.nextUrl`	`string \| null`	No	—	Format: `uri`.
`result.meta`	`object`	No	—	—

Deepline cost

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

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation