Skip to content
API docs
Sign inOpen app

Forms

List forms

GET/v1/forms

List the workspace's forms, newest first, up to 500. Drafts aren't included. A member limited to some brands gets only those brands' forms (see Brand access).

Query parameters

  • workspaceIdstring

    Optional. Your API key already belongs to one workspace.

  • brandIdstring

    Only list this brand's forms.

Response

A list of objects.

  • idstringrequired

    The form's id.

  • brandIdstringrequired

    The brand the form belongs to.

  • workspaceIdstringrequired

    The workspace the form belongs to.

  • namestringrequired

    The form's name.

  • statusenumrequired

    draft until it's first published, then published while it's live. unpublished once it's taken offline; its versions are kept.

    One of "draft", "published", "unpublished"

  • publishedVersionnumber or nullrequired

    The number of the live version. Null if the form was never published.

  • publishedAtnumber or nullrequired

    When the latest version was published, in milliseconds since the epoch. Null if never.

  • hasUnpublishedChangesbooleanrequired

    Whether the draft or theme overrides changed since the form was last published.

  • changedAtnumber or nullrequired

    When the draft or theme overrides last changed, in milliseconds since the epoch. Null if they were never edited.

  • partialCapturebooleanrequired

    Whether the draft has "Save unfinished responses" on. The webhook event for people who left (submission.abandoned) needs it, and the plan feature partialCapture too.

  • stepCountintegerrequired

    How many steps the draft has.

    -9007199254740991–9007199254740991

  • blockCountintegerrequired

    How many questions and other blocks the draft has, across all steps.

    -9007199254740991–9007199254740991

  • createdAtnumberrequired

    When the form was created, in milliseconds since the epoch.

  • updatedAtnumberrequired

    When anything about the form last changed, in milliseconds since the epoch.

Errors answer with a status and the error shape.