> Home > API

get_forms API

Returns a list of forms.

Test this endpoint:

http://panel.findacode.com/api/get_forms.php

site_id=	(REQUIRED)
&item_ids=	(optional - one or more item record IDs, comma separated, if item_ids is passed in any tags parameters - shown below - will be ignored)
&tags=	(optional - one or more tags, comma separated, URL Encoded) Tag Ex: Topic: ABN - Advanced Beneficiary Notice Tags Ex: Topic: ABN - Advanced Beneficiary Notice, Payer: CMS/Medicare
	If multiple tags[n] parameters are used, the item must have at least one tag in each of the "tags" groups. A single tag in a group will require that that specific tag be associated with the item.
&tags2=	(optional - one or more tags, comma separated, URL Encoded)
&tags3=	(optional - one or more tags, comma separated, URL Encoded)
&order=	(optional, default: date)
&order2=	(optional)
&count=	(optional, the number of items to return)
&page=	(optional, the set of items based on the count, ex: if count=10, page=1 returns 1-10, page=2 returns 11-20, etc)
&format=	(optional, default: json)

(opens in a new tab)

Returns

id: ID value of the form

url: url of the form page

group: group of the form

title: title of the form

body: description of the form

icon_image_id: ID of the image that can be used as an icon for the form

download1_url: URL of the first file that can be downloaded

download1_text: text label for the first file that can be downloaded

download2_url: URL of the second file that can be downloaded

download2_text: text label for the second file that can be downloaded

download3_url: URL of the third file that can be downloaded

download3_text: text label for the third file that can be downloaded

sticky: Y/N - Y if the item should be placed at the top of a list of items

tags: tags associated with the form

last_updated: date/time the form record was last updated

total_items: the total number of items available for the given conditions, used to calculate the number pages when using count, will be the same for all items returned