Nooks: List Users

List users.

Tool ID: nooks_list_users

Run this action

Use the TypeScript SDK for a single call. Put ctx.tools.execute(...) inside a Play when the call should be durable, scheduled, or run across a CSV.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'nooks_list_users',
  {
    "page": {
      "size": 50,
      "after": "cursor_123",
      "before": "cursor_123"
    },
    "filter": {
      "name": "Example",
      "email": "jane.doe@example.com",
      "crmId": "crm_123"
    }
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute nooks_list_users --input '{
  "page": {
    "size": 50,
    "after": "cursor_123",
    "before": "cursor_123"
  },
  "filter": {
    "name": "Example",
    "email": "jane.doe@example.com",
    "crmId": "crm_123"
  }
}' --json

Example response

The static output schema is not detailed enough to generate a reliable example. Use deepline tools get nooks_list_users --json for the complete live contract.

Input reference

Returns a paginated list of users in the workspace. Only users with active seat assignments are returned. Example: bash curl -X GET 'https://partner-api.nooks.in/v1/users?page[size]=50' \ -H "Authorization: Bearer nooks-api-..." Filter by email:

bash curl -X GET 'https://partner-api.nooks.in/v1/users?filter[email]=jane@example.com' \ -H "Authorization: Bearer nooks-api-..."

Filter by CRM id — looks up the Nooks user mapped to the given external id in the connected CRM (e.g. a Salesforce User.Id / OwnerId). Returns an empty list if no Nooks user is mapped to that id:

bash curl -X GET 'https://partner-api.nooks.in/v1/users?filter[crmId]=0051a000000XyzABC' \ -H "Authorization: Bearer nooks-api-..."

Name	Type	Required	Default	Details
`payload.page`	`object`	No	—	Number of items per page (max 100)
`payload.filter`	`object`	No	—	Filter users by exact name match

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	Provider response payload.
`result.data.data`	`array`	No	—	—
`result.data.data[].id`	`string`	Yes	—	Unique identifier for the user
`result.data.data[].name`	`string`	Yes	—	Full name of the user
`result.data.data[].email`	`string`	Yes	—	Email address of the user Format: `email`.
`result.data.data[].crmId`	`string \| null`	Yes	—	The user’s id in the customer’s CRM of record (e.g. a Salesforce User.Id / OwnerId), resolved via the workspace’s CRM user mappings. Null when the user has no CRM mapping.
`result.data.data[].createdAt`	`string`	Yes	—	When the user was created Format: `date-time`.
`result.data.data[].updatedAt`	`string`	Yes	—	When the user was last updated Format: `date-time`.
`result.data.links`	`object`	No	—	Pagination links for navigating through results. Links are returned as relative references (path + query) that should be resolved against the base URL of the request.
`result.data.links.first`	`string`	No	—	URL for the first page Format: `uri-reference`.
`result.data.links.prev`	`string \| null`	No	—	URL for the previous page (null if on first page) Format: `uri-reference`.
`result.data.links.next`	`string \| null`	No	—	URL for the next page (null if on last page) Format: `uri-reference`.
`result.meta`	`object`	No	—	Additional response metadata (status, paging).

Deepline cost

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

Get started

Build and automate

Common workflows

Data and integrations

Reference

Nooks: List Users

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

​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