> ## 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.
# Nooks List Users: Inputs, Cost & CLI Example
> List users. Nooks Nooks List Users docs include request fields, response shape, pricing notes, and Deepline CLI examples.
## Run in Enrichment Spreadsheet
Use this function as a column step in `deepline enrich`.
```bash theme={null}
deepline enrich --input leads.csv --output leads.enriched.csv --with 'result=nooks_list_users:{}' --json
```
Map payload values to spreadsheet columns with `{{column_name}}` placeholders.
## Input Schema
| Name | Type | Required | Default | Description |
| ---------------- | -------- | -------- | ------- | ---------------------------------- |
| `payload.page` | `object` | No | | Number of items per page (max 100) |
| `payload.filter` | `object` | No | | Filter users by exact name match |
Show raw input schema
### Input JSON Schema
````json theme={null}
{
"type": "object",
"description": "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-...\" ```",
"properties": {
"page": {
"type": "object",
"description": "Number of items per page (max 100)",
"properties": {
"size": {
"type": "integer",
"description": "Number of items per page (max 100)",
"default": 50,
"minimum": 1,
"maximum": 100
},
"after": {
"type": "string",
"description": "Cursor for fetching the next page. Opaque token returned by the API in `links.next`; callers should treat it as opaque and only pass values they received from a previous response. Malformed cursors return `400 Bad Request`."
},
"before": {
"type": "string",
"description": "Cursor for fetching the previous page. Opaque token returned by the API in `links.prev`; callers should treat it as opaque and only pass values they received from a previous response. Malformed cursors return `400 Bad Request`."
}
},
"required": [],
"additionalProperties": false
},
"filter": {
"type": "object",
"description": "Filter users by exact name match",
"properties": {
"name": {
"type": "string",
"description": "Filter users by exact name match"
},
"email": {
"type": "string",
"description": "Filter users by exact email match.",
"format": "email"
},
"crmId": {
"type": "string",
"description": "Filter to the Nooks user mapped to the given id in the customer's CRM (e.g. a Salesforce User.Id or OwnerId). Resolved via the workspace's CRM user mappings. Returns an empty list if no Nooks user is mapped to the given id."
},
"updatedAt": {
"type": "object",
"description": "Filter by minimum updatedAt (ISO 8601 datetime)",
"properties": {
"gte": {
"type": "string",
"description": "Filter by minimum updatedAt (ISO 8601 datetime)",
"format": "date-time"
},
"lt": {
"type": "string",
"description": "Filter by updatedAt before this timestamp, exclusive (ISO 8601 datetime)",
"format": "date-time"
}
},
"required": [],
"additionalProperties": false
}
},
"required": [],
"additionalProperties": false
}
},
"required": [],
"additionalProperties": false
}
````
## Output Schema
| Name | Type | Required | Default | Description |
| ------------- | -------- | -------- | ------- | ---------------------------------------------- |
| `result.data` | `object` | Yes | | Provider response payload. |
| `result.meta` | `object` | No | | Additional response metadata (status, paging). |
Show raw output schema
### Output JSON Schema
```json theme={null}
{
"type": "object",
"description": "Standard tool result payload.",
"properties": {
"data": {
"type": "object",
"description": "Provider response payload.",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"description": "A workspace user",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier for the user"
},
"name": {
"type": "string",
"description": "Full name of the user"
},
"email": {
"type": "string",
"description": "Email address of the user",
"format": "email"
},
"crmId": {
"type": [
"string",
"null"
],
"description": "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."
},
"createdAt": {
"type": "string",
"description": "When the user was created",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"description": "When the user was last updated",
"format": "date-time"
}
},
"required": [
"id",
"name",
"email",
"crmId",
"createdAt",
"updatedAt"
],
"additionalProperties": false
}
},
"links": {
"type": "object",
"description": "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.",
"properties": {
"first": {
"type": "string",
"description": "URL for the first page",
"format": "uri-reference"
},
"prev": {
"type": [
"string",
"null"
],
"description": "URL for the previous page (null if on first page)",
"format": "uri-reference"
},
"next": {
"type": [
"string",
"null"
],
"description": "URL for the next page (null if on last page)",
"format": "uri-reference"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"meta": {
"type": "object",
"description": "Additional response metadata (status, paging).",
"additionalProperties": true
}
},
"required": [
"data"
],
"additionalProperties": false
}
```
## Advanced: Direct CLI
Use direct execution for single payload debugging.
```bash theme={null}
deepline tools execute nooks_list_users --payload '{}' --json
```
### CLI flags
| Flag | Description |
| --------------------------- | --------------------------------------------------- |
| `--json` | Print machine-readable output. |
| `--wait` | Wait for terminal provider status when supported. |
| `--debug` | Enable wait mode with additional status/log output. |
| `--wait-timeout SECONDS` | Max seconds to wait in wait mode. |
| `--poll-interval SECONDS` | Polling interval in seconds during wait mode. |
| `--timeout SECONDS` | Request timeout in seconds. |
| `--connect-timeout SECONDS` | Connection timeout in seconds. |
## Cost
* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.
* Billing mode: `no_bill`.