> ## 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: Get User

> Get a user in your Nooks workspace by their ID. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Get a user in your Nooks workspace by their ID.

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

## 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(
  'nooks_get_user',
  {
    "id": "id_123"
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute nooks_get_user --input '{
  "id": "id_123"
}' --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": {
    "id": "id_123",
    "name": "Example",
    "email": "jane.doe@example.com",
    "crmId": "crm_123",
    "createdAt": "2026-01-15T12:00:00Z",
    "updatedAt": "2026-01-15T12:00:00Z"
  }
}
```

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

## Input reference

Returns a single user by their unique identifier. Returns 404 if the user does not exist or does not have a seat assignment in the workspace. Example: `bash curl -X GET 'https://partner-api.nooks.in/v1/users/KKLvN5wQoghWFwUvC75CZ12QM7I3' \ -H "Authorization: Bearer nooks-api-..." `

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.id` | `string` | Yes | — | Unique identifier for the user |

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

  ### Input JSON Schema

  ````json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Returns a single user by their unique identifier. Returns 404 if the user does not exist or does not have a seat assignment in the workspace. Example: ```bash curl -X GET 'https://partner-api.nooks.in/v1/users/KKLvN5wQoghWFwUvC75CZ12QM7I3' \\ -H \"Authorization: Bearer nooks-api-...\" ```",
    "properties": {
      "id": {
        "type": "string",
        "description": "Unique identifier for the user"
      }
    },
    "required": [
      "id"
    ],
    "additionalProperties": false
  }
  ````
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | A workspace user |
| `result.data.id` | `string` | Yes | — | Unique identifier for the user |
| `result.data.name` | `string` | Yes | — | Full name of the user |
| `result.data.email` | `string` | Yes | — | Email address of the user Format: `email`. |
| `result.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.createdAt` | `string` | Yes | — | When the user was created Format: `date-time`. |
| `result.data.updatedAt` | `string` | Yes | — | When the user was last updated Format: `date-time`. |
| `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": "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
      },
      "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

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