# Get Record(s) — Knack

> Get one or more Records for a Knack object (See docs here)

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

## Description

Get one or more Records for a Knack object [(See docs here)](https://docs.knack.com/docs/retrieving-records)

## Props

| Prop | Type | Required | Description |
|---|---|---|---|
| `objectKey` | `string` | Yes | The key of the object which this record belongs to. See the Knack API docs for more information. |
| `recordId` | `string` | No | The ID of the record to retrieve. If not specified, all records for the specified object will be retrieved. See the Knack API docs for more information. |
| `sortField` | `string` | No | The field key to sort the records by. Use in conjunction with Sort Order. Example value: field_1 See the Knack API docs for more information. |
| `sortOrder` | `string` | No | The order to sort the records by, based on Sort Field. |
| `filters` | `string[]` | No | One or more filters the returned records should match. Each filter should be a string representing a JSON object. Example value: { "field": "field_1", "operator": "contains", "value": "my name" } See the Knack API docs for more information. |
| `filterType` | `string` | No | If using multiple Filters, sets whether the returned records should match any or all filters specified. |

## 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": "knack",
      },
    },
  },
)

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: "knack-get-record",
  arguments: {
    objectKey: "Object Key",
    recordId: "Record ID",
  },
})
```

**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: "knack-get-record",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    knack: { authProvisionId: "apn_xxxxxxx" },
    objectKey: "Object Key",
    recordId: "Record ID",
  },
})

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": "knack-get-record",
    "configured_props": {
      "knack": { "authProvisionId": "apn_xxxxxxx" },
      "objectKey": "Object Key",
      "recordId": "Record ID"
    }
  }'
```

---

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