3.0 KiB
3.0 KiB
Tally Routing Reference
App name: tally
Base URL proxied: api.tally.so
API Path Pattern
/tally/{resource}
Tally's API does not use version prefixes in paths.
Required Headers
THe User-Agent header is required to avoid Cloudflare blocks:
User-Agent: Maton/1.0
Common Endpoints
Get Current User
GET /tally/users/me
List Forms
GET /tally/forms
Query Parameters:
page- Page number (default: 1)limit- Items per page (default: 50)
Get Form
GET /tally/forms/{formId}
Create Form
POST /tally/forms
Content-Type: application/json
{
"status": "DRAFT",
"blocks": [
{
"type": "FORM_TITLE",
"uuid": "11111111-1111-1111-1111-111111111111",
"groupUuid": "22222222-2222-2222-2222-222222222222",
"groupType": "FORM_TITLE",
"title": "My Form",
"payload": {}
},
{
"type": "INPUT_TEXT",
"uuid": "33333333-3333-3333-3333-333333333333",
"groupUuid": "44444444-4444-4444-4444-444444444444",
"groupType": "INPUT_TEXT",
"title": "Your name",
"payload": {}
}
]
}
Update Form
PATCH /tally/forms/{formId}
Content-Type: application/json
{
"name": "Updated Form Name",
"status": "PUBLISHED"
}
Delete Form
DELETE /tally/forms/{formId}
List Form Questions
GET /tally/forms/{formId}/questions
List Form Submissions
GET /tally/forms/{formId}/submissions
Query Parameters:
page- Page numberlimit- Items per pagestartDate- Filter by start date (ISO 8601)endDate- Filter by end date (ISO 8601)afterId- Cursor for pagination
Get Submission
GET /tally/forms/{formId}/submissions/{submissionId}
Delete Submission
DELETE /tally/forms/{formId}/submissions/{submissionId}
List Workspaces
GET /tally/workspaces
Get Workspace
GET /tally/workspaces/{workspaceId}
Create Workspace
POST /tally/workspaces
Content-Type: application/json
{
"name": "New Workspace"
}
List Organization Users
GET /tally/organizations/{organizationId}/users
List Organization Invites
GET /tally/organizations/{organizationId}/invites
List Webhooks
GET /tally/webhooks
Create Webhook
POST /tally/webhooks
Content-Type: application/json
{
"formId": "GxdRaQ",
"url": "https://your-endpoint.com/webhook",
"eventTypes": ["FORM_RESPONSE"]
}
Notes
- Form and workspace IDs are short alphanumeric strings (e.g.,
GxdRaQ,3jW9Q1) - Block
uuidandgroupUuidfields must be valid UUIDs (GUIDs) - Page-based pagination with
pageandlimitparameters - Rate limit: 100 requests per minute
- API is in public beta and subject to changes
- Creating workspaces requires a Pro subscription