Formspark Octri Preview
GET/forms

List forms

Lists forms in a workspace, with the newest forms first. Supply the workspaceId to select the workspace, and use limit and startingAfter to control page size and paginate through results; the default limit is 25.

3 parameters
limitintegeroptional
Maximum number of forms to return. Must be between 1 and 100. Defaults to 25 when omitted.
startingAfterstringoptional
Cursor for the next page of results, using the `nextCursor` value from the previous response.
workspaceIdstringrequired
The workspace whose forms to list. Must contain at least one character.

7 status codes
200Returns a page containing form objects in `data`, a `hasMore` indicator, and a `nextCursor` for retrieving the next page. Form objects include their IDs, names, descriptions, workspace IDs, and form configuration.
dataarray<object>required
hasMorebooleanrequired
nextCursorstringrequired
400Returned when the request is malformed or fails validation.
codestringrequired
detailstringrequired
statusnumberrequired
titlestringrequired
typestringrequired
401Returned when the token is missing, malformed, revoked, or expired.
codestringrequired
detailstringrequired
statusnumberrequired
titlestringrequired
typestringrequired
403Returned when the token lacks the scope required for this operation, the workspace is not upgraded, or a limit has been reached.
codestringrequired
detailstringrequired
statusnumberrequired
titlestringrequired
typestringrequired
404Returned when the resource does not exist.
codestringrequired
detailstringrequired
statusnumberrequired
titlestringrequired
typestringrequired
429Returned when the caller is rate limited and should retry later.
codestringrequired
detailstringrequired
statusnumberrequired
titlestringrequired
typestringrequired
500Returned when an error occurs on the server.
codestringrequired
detailstringrequired
statusnumberrequired
titlestringrequired
typestringrequired

Error handling

A 400 is returned when the request is malformed or fails validation; a 401 when the token is missing, malformed, revoked, or expired; a 403 when the token lacks the required scope, the workspace is not upgraded, or a limit is reached; a 404 when the resource does not exist; a 429 when the caller is rate limited; and a 500 when an error occurs on the server. The workspaceId query parameter must contain at least one character, and limit must be between 1 and 100 when supplied.