Get Forms
Retrieve form definitions — structure, questions, and settings.
Endpoints
| Method | Endpoint | Description |
|---|---|---|
| GET | /forms/v1/forms | Paginated list of forms |
| GET | /forms/v1/forms/{formId} | Single form by ID |
Authentication
- API Key (
X-API-KEYheader), or - OAuth 2.0 with scope
forms.read
GET /forms/v1/forms — Query Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| startDate | string (YYYY-MM-DD) | No | — | Return forms created on or after this date (inclusive). Filters on form creation date. |
| endDate | string (YYYY-MM-DD) | No | — | Return forms created on or before this date (inclusive). Filters on form creation date. |
| limit | integer | No | 10 | Max results per page. Range 1–300. |
| offset | integer | No | 0 | Number of results to skip. |
Date filters
startDateandendDateare optional and independent — use either, both, or neither. Dates are interpreted in UTC (start of day forstartDate, end of day forendDate).
Example — Forms created in February 2024
curl --request GET \
--url 'https://api.connecteam.com/forms/v1/forms?startDate=2024-02-01&endDate=2024-02-29&limit=50' \
--header 'X-API-KEY: YOUR_API_KEY'Example — Single form
curl --request GET \
--url 'https://api.connecteam.com/forms/v1/forms/123456789' \
--header 'X-API-KEY: YOUR_API_KEY'Response Fields (form object)
| Field | Type | Description |
|---|---|---|
| formId | integer | Unique form identifier. |
| formName | string | Form title. |
| createdAt | integer | Creation time (Unix timestamp). |
| lastUpdatedAt | integer | Last update time (Unix timestamp). |
| questions | array | Form questions (typed by questionType). |
| settings | object | Form configuration (sharing, notifications, etc.). |
List responses wrap forms in data.forms with standard paging.offset.
Error Codes
| HTTP Status | Description |
|---|---|
401 | Missing or invalid authentication. |
403 | Token lacks forms.read or plan does not include the Forms API. |
404 | Form ID not found (single-form endpoint). |
422 | Invalid query parameter format. |
Updated 24 days ago
Did this page help you?
