v1

latestOpenAPI 3.0.22026-07-146168117.0 KB
Forms

This endpoint returns a list of forms that are accessible by the authorized user. This feature is available as part of the Standard API.

get/forms

Query parameters

searchstring

Search forms by title.

search_fieldsstring[]

Opt-in list of fields to match the search term against. When omitted, the search term is matched against the form title only. Provide one or more of title, slug, custom_slug to broaden the search (e.g. to find a form by its slug). Each field is matched as a partial, case-insensitive substring.

limitinteger

The number or results to return.

skipinteger

Number of results to skip in the result set.

after_idstring

Return results after the provided ID.

before_idstring

Return results before the provided ID.

before_datestring date-time

Return results created on or after this date-time (UTC). Overwritten by before_id.

after_datestring date-time

Return results created before this date (UTC). Overwritten by after_id.

sort'ASC' | 'DESC'

The direction to sort in. Results are sorted by created_at, and defaults to "DESC".

Response

Successfully returned a list of forms

status'ok'
totalinteger

The total number of items.

has_moreboolean

Whether there are more items.

limitinteger

The limit of items per page.

skipinteger

The number of items to skip.

Example response

{
  "results": {
    "forms": [
      {
        "id": "5d40fdaf174b4c0007043072",
        "slug": "67fqxwkp",
        "custom_slug": "my-form-slug",
        "title": "My Form Title",
        "description": "This is a description for my form",
        "cover_image_url": "https://s3-ap-southeast-2.amazonaws.com/paperform/u-22714/1/2019-04-14/58p3u6p/cabinet-clothes-clothes-hanger-996329.jpg",
        "url": "https://lffa4fxo.paperform.co",
        "live": true,
        "submission_count": 50,
        "created_at": "2019-04-14T09:00:00.000Z",
        "updated_at": "2019-04-14T09:00:00.000Z",
        "account_timezone": "Australia/Sydney",
        "created_at_utc": "2019-04-14T09:00:00.000Z",
        "updated_at_utc": "2019-04-14T09:00:00.000Z"
      }
    ]
  },
  "total": 57,
  "has_more": true,
  "limit": 20
}
All 61 operations