List notes with the folk API

Lists the notes of the workspace with content, visibility, author, creation date and the person, company or object each one belongs to. query searches the content. The next page comes from the cursor inside pagination.nextLink; the last page has no nextLink.

Identifier
folk_list_notes

The request

POST https://connect.reportei.com/api/tools/folk_list_notes/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "query": "<query>"
  }
}

Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.

Parameters

ParameterTypeRequiredDescription
querystringNoFull-text search in the note content.
createdAfterstringNoOnly notes created after this moment, in ISO 8601.
createdBeforestringNoOnly notes created before this moment, in ISO 8601.
limitintegerNoResults per page, up to 100. Defaults to 20.
cursorstringNoThe cursor value inside pagination.nextLink of the previous response, URL-decoded (%3D becomes =). Omit it on the first call.

Supported connections

Your customer connects their folk account once, with one of the modes below. The same connection serves every tool of the toolkit.

API key

Your customer pastes the app's key on a Connect screen, or your system sends the key with POST /api/customer-toolkits, with no screen.

The response

On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.

Ready for AI agents

This tool's input is a JSON Schema, available at GET /api/tools/folk_list_notes. It becomes your agent's tool definition with no conversion.

Other folk tools

See all 13 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.