Skip to content
/Form Module

List forms

Request

Returns the forms in the account you are calling as, together with the forms it inherits from the accounts above it.

This is an administration endpoint. It answers only for callers who may read forms and who are calling as the admin console; for anyone else it answers as though it does not exist. A caller who only needs to fill a form in should read it through GET /form/{id}/view instead, or through the endpoint of whatever the form is attached to.

is_submissions_listing and is_admin_submissions_listing narrow the result to the forms behind the two submission listings, and are mutually exclusive - if both are sent, the admin one wins.

Security
default
Query
is_submissions_listingboolean

Return only forms whose submissions are collected from the people filling them in, excluding admin submission forms.

is_admin_submissions_listingboolean

Return only admin submission forms - the ones an administrator completes about somebody else.

report_type_idinteger

Narrow the result to the forms a report of this type can be built from.

per_pageinteger

The number of results to return per page. The higher the number the longer the request may take. It is highly recommended to use this to avoid timeouts as your data grows. Used in conjunction with the page parameter to paginate results.

pageinteger

The page of results to return. Used in conjunction with the per_page parameter to paginate results. If not specified, defaults to 1. The response's next_page_url will be null if there are no more pages.

filterArray of objects

A filter to apply to the results. Declared as an array of objects, where each object contains an attr (attribute code), operator and value key. Examples:

?filter[0]['attr']=name&filter[0][operator]=like&filter[0][value]=luke

?filter[0]['attr']=id&filter[0][operator]=>&filter[0][value]=265

See the filters documentation for more details on how to use this.

sort_bystring

The field to sort the results by. No ordering is applied unless you specify one, so row order is not guaranteed. Always send it when paging through a list, otherwise records can repeat or be missed between pages. Example: id

sort_orderstring

The direction to sort the results by. Can be 'asc' or 'desc', default is 'asc'.

Enum:"asc""desc"
_localestring

The locale to use for the response. This primarily affects the results of the nice field, which contain human-readable labels and terms, as well as locale-specific date formats.,

Headers
Rosterfy-Platformstring
curl -i -X GET \
  'https://developer.rosterfy.com/_mock/api-docs/openapi/api/v2/form?is_submissions_listing=true&is_admin_submissions_listing=true&report_type_id=3&per_page=5&page=1&filter=%7Bfilter%7D&sort_by=%7Bsort_by%7D&sort_order=%7Bsort_order%7D&_locale=en-US' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Rosterfy-Platform: admin'

Responses

Successful response

Bodyapplication/json
Array [
current_pageinteger
dataArray of objects
first_page_urlstring
frominteger
next_page_urlstring
pathstring
per_pageinteger
prev_page_urlstring or null
tointeger
]
Response
[
  {
    "current_page": 1,
    "data": [ … ],
    "first_page_url": "https://example.rosterfy.com/api/v2/form?per_page=5&_locale=en-US&page=1",
    "from": 1,
    "next_page_url": "https://example.rosterfy.com/api/v2/form?per_page=5&_locale=en-US&page=2",
    "path": "https://example.rosterfy.com/api/v2/form",
    "per_page": 5,
    "prev_page_url": null,
    "to": 5
  }
]