Get form with the Tally API
Returns a form with its settings and every block, each with uuid, type, groupUuid, groupType and payload. Update form takes the blocks back in this format.
- Identifier
- tally_get_form
The request
POST https://connect.reportei.com/api/tools/tally_get_form/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"form_id": "<form_id>"
}
}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
| Parameter | Type | Required | Description |
|---|---|---|---|
| form_id | string | Yes | Id of the form, from List forms or from the form URL: wA0Bc1 in https://tally.so/r/wA0Bc1. |
Supported connections
Your customer connects their Tally 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/tally_get_form. It becomes your agent's tool definition with no conversion.
Other Tally tools
- List workspacesGETLists the workspaces of the organization with id, name, members, pending invites and folders, each with id and name. Paginate with page while hasMore is true.
- List formsGETLists the forms with id, name, workspaceId, status, numberOfSubmissions, isClosed and dates. Paginate with page while hasMore is true.
- Create formPOSTCreates a form from its blocks and returns its id, name, workspace and status. The form goes to the default workspace unless workspaceId is sent.
- Update formPATCHChanges the name, status, settings or blocks of a form. Sending blocks replaces all of them, so read the form with Get form first; name, status and settings can go alone.
- List form submissionsGETLists the submissions of a form, each with id, isCompleted, submittedAt, the preview and PDF links and its responses, plus the questions of the form, so each response maps to a question by questionId. Paginate with page while hasMore is true.
- Get form submissionGETReturns one submission with all its responses and the questions of the form.
- Get form metricsGETReturns the totals of a form in the period: visits, total views, starts, submissions, completions, unique respondents, completion rate and the average visit and completion durations.
- Get form visitsGETReturns the visits of a form over the period, as counts per interval.
Toolkits in the same category
See all 100 toolkitsSee Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
