View as Markdown
Knack icon

Knack ACTION

Get Record(s)

Get one or more Records for a Knack object (See docs here)
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Knack account once, then configure and run Get Record(s) from your backend or agent.

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)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Get Record(s) inputs
Property Type Description
objectKey Object Key string
The key of the object which this record belongs to.
See the Knack API docs for more information.
Required
recordId Record ID string
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.
Optional
sortField Sort Field string
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.
Optional
sortOrder Sort Order string
The order to sort the records by, based on Sort Field.
Optional
filters Filters string[]
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.
Optional
filterType Filter Type string
If using multiple Filters, sets whether the returned records should match any or all filters specified.
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
knack-get-record
Version
0.0.3
App
Knack
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes