7/15/24, 6:14 PM

GET Folder (Search)

TABLE OF CONTENTS
Parameters
Example
ADDITIONAL INFO
API Explorer
General Information

The GET Folder (Search) API finds all folders matching the given parameters.

On the Cloud, this API is available via SSL-secured HTTPS connection using the REST GET verb.
The format query string parameter controls the desired response format. Specify either XML or JSON.

/api/v2/folder/search?format=xml/json

You may use either JSON or XML formats in your GET request.
You indicate this by setting the ContentType HTTP header as "application/json" or "application/xml".
If no ContentType is specified, XML format is assumed.

All XML formatted requests must specify the following XML namespace in the data source root element:
xmlns:i="http://www.w3.org/2001/XMLSchema-instance"

Parameters
The GET Folder (Search) API finds all folders matching the given parameters.
The required and optional parameters for a GET call to the Folder API are outlined below.

Name Type Description Required

Your unique Company ID found on the Organization Setup page of
CompanyId Integer ✓
the secure website.
Your unique Integration Key found on the Organization Setup page
IntegrationKey String ✓
of the secure website.
Name String Folder name to search for.
ExternalId String Folder external ID to search for.
PageNo Integer The page number from which to start reading results (0 based).
The page size (number of rows) to return. Maximum allowable value
PageSize Integer
is 250.

1 / 12
 7/15/24, 6:14 PM

Example
Given that the API is REST-based, you can access the API directly via your web browser to test or by using the Postman
API Platform.

The below example demonstrates a simple request returning all Folders from a specific company account.

Request URL
https://secure.formsonfire.com:443/api/v2/folder/search?CompanyId=6XXXX&Integration

Response Body
{
"Folders": [
{
"Id": "8b7XXXXXXXXXXXXXXXXXXXXXXXXXXX",
"Name": "Asset Manager",
"CompanyId": 6XXXX
},
{
"Id": "1bdXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"Name": "Drill Log & Timesheet",
"CompanyId": 6XXXX
},
{
"Id": "2ceXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"Name": "Field Sales App",
"CompanyId": 6XXXX
},
{
"Id": "31fXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"Name": "GeneralApps",
"CompanyId": 6XXXX
},
{
"Id": "409XXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"Name": "Inventory App",
"CompanyId": 6XXXX
},
{
"Id": "5caXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"Name": "RETIRED",
"IsRestricted": true,
"CompanyId": 6XXXX
}
],
"TotalRows": 6
}

2 / 12
7/15/24, 6:14 PM

3 / 12
 7/15/24, 6:14 PM

POST Folder
TABLE OF CONTENTS
Parameters
Example
ADDITIONAL INFO
API Explorer
General Information

The POST Folder API creates a new folder in the company's account.

On the Cloud, this API is available via SSL-secured HTTPS connection using the REST POST verb.
The format query string parameter controls the desired response format. Specify either XML or JSON.

/api/v2/folder?format=xml/json

You may use either JSON or XML formats in your POST request.
You indicate this by setting the ContentType HTTP header as "application/json" or "application/xml".
If no ContentType is specified, XML format is assumed.

All XML formatted requests must specify the following XML namespace in the data source root element:
xmlns:i="http://www.w3.org/2001/XMLSchema-instance"

Parameters
The POST Folder API allows you to create a new folder in your company account.
The required and optional parameters for a POST call to the Folder API are outlined below.

Name Type Description Required

Id String GUID of the folder you'd like to create.
Name String Name of the folder you'd like to create. ✓
ExternalId String External ID of the form you'd like to create.
IsRestricted Boolean Whether or not this Folder restricts user access to its contents.
Restrict access to a specific User Group identifier. This only
allows access to users in the selected group. Users in this
RestrictToGroup String
Group will also be able to access all items not assigned to any
Groups.
Description String Description of the Folder.
GUID of the object to be included in the folder, ie. Screen or
Items Array
Data Source.
Your unique Company ID is found on the Organization Setup
CompanyId Integer ✓
page of the secure website.
Your unique Integration Key is found on the Organization Setup
IntegrationKey String ✓
page of the secure website.

4 / 12
 7/15/24, 6:14 PM

KeyId String The ID of the linked item.

Type String ['Screen', 'Doc', 'DataSource', 'Folder', 'TaskTemplate']

Example
Given that the API is REST-based, you can access the API directly via your web browser to test or by using the Postman
API Platform.

The below example demonstrates how to create a new folder using a POST Folder API call.

Request URL
https://secure.appenate.com:443/api/v2/folder

Request Body
{
"Id": "",
"Name": "Test App 2",
"ExternalId": "",
"IsRestricted": false,
"RestrictToGroup": "",
"Description": "",
"CompanyId": 60XXX,
"IntegrationKey": "995XXXXXXXXXXXXXXXXXXXXXXX"
}

5 / 12
 7/15/24, 6:14 PM

GET Folder
TABLE OF CONTENTS
Parameters
Example
ADDITIONAL INFO
API Explorer
General Information

The GET Folder API returns details of the Folder matching the given parameters.

On the Cloud, this API is available via SSL-secured HTTPS connection using the REST GET verb.
The format query string parameter controls the desired response format. Specify either XML or JSON.

/api/v2/folder?format=xml/json

You may use either JSON or XML formats in your GET request.
You indicate this by setting the ContentType HTTP header as "application/json" or "application/xml".
If no ContentType is specified, XML format is assumed.

All XML formatted requests must specify the following XML namespace in the data source root element:
xmlns:i="http://www.w3.org/2001/XMLSchema-instance"

Parameters
The GET Folder API returns all properties of the Folder matching the given parameters.
The required and optional parameters for a GET call to the Folder API are outlined below.

Name Type Description Required

Your unique Company ID is found on the Organization Setup page of
CompanyId Integer ✓
the secure website.
Your unique Integration Key is found on the Organization Setup page
IntegrationKey String ✓
of the secure website.
Name String Title of the Folder. ✓*
ExternalId String Folder external ID to search for. ✓*
Id String The Folder's unique identifier. ✓*
✓* - You must specify either a folder ID, folder Name, or folder ExternalId

Example
Given that the API is REST-based, you can access the API directly via your web browser to test or by using the Postman
API Platform.

The below example demonstrates a simple request returning details of a specified Folder.

6 / 12
 7/15/24, 6:14 PM

Request URL
https://secure.formsonfire.com.com:443/api/v2/folder?CompanyId=60XXX&IntegrationKey

Response Body
{
"Folder": {
"Id": "301XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"Name": "Test Apps",
"IsRestricted": false,
"Items": [
{
"KeyId": "43eXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"Type": "Screen"
},
{
"KeyId": "1cdXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"Type": "Screen"
},
{
"KeyId": "cb4XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"Type": "DataSource"
},
{
"KeyId": "747XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"Type": "Screen"
},
{
"KeyId": "c71XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"Type": "DataSource"
},
{
"KeyId": "ff4XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"Type": "Screen"
},
{
"KeyId": "b46XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"Type": "DataSource"
},
{
"KeyId": "a05XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"Type": "DataSource"
},
{
"KeyId": "e71XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"Type": "Screen"
},
{

7 / 12
 7/15/24, 6:14 PM

"KeyId": "46bXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"Type": "Screen"
},
{
"KeyId": "1e6XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"Type": "Screen"
}
],
"CompanyId": 6XXXX
}
}

8 / 12
 7/15/24, 6:14 PM

DELETE Folder
TABLE OF CONTENTS
Parameters
Example
ADDITIONAL INFO
API Explorer
General Information

The DELETE Folder API allows you to remove an existing folder from a company account.

On the Cloud, this API is available via SSL-secured HTTPS connection using the REST DELETE verb.
The format query string parameter controls the desired response format. Specify either XML or JSON.

/api/v2/folder?format=xml/json

You may use either JSON or XML formats in your DELETE request.
You indicate this by setting the ContentType HTTP header as "application/json" or "application/xml".
If no ContentType is specified, XML format is assumed.

All XML formatted requests must specify the following XML namespace in the data source root element:
xmlns:i="http://www.w3.org/2001/XMLSchema-instance"

Parameters
The required parameters for a PUT request to the Screens API are outlined below:

Name Type Description Required

Your unique Company ID is found on the Organization Setup
CompanyId Integer ✓
page of the secure website.
Your unique Integration Key is found on the Organization
IntegrationKey String ✓
Setup page of the secure website.
Id String The Folder's unique identifier. ✓*
Name String Name of the folder you'd like to delete. ✓*
ExternalId String ExternalId of the folder you'd like to delete. ✓*
✓* - At least one of these values must be specified (ID, Name, or ExternalId)

Example
Given that the API is REST-based, you can access the API directly via your web browser to test or by using the Postman
API Platform.

The below example demonstrates how to delete an existing folder using a DELETE Folder API call.

9 / 12
 7/15/24, 6:14 PM

Request URL
https://secure.formsonfire.com:443/api/v2/folder?CompanyId=6XXXX&IntegrationKey=995

Response Body
{}

Response Code
200

10 / 12
 7/15/24, 6:14 PM

PUT Folder
TABLE OF CONTENTS
Parameters
Example
ADDITIONAL INFO
API Explorer
General Information

This API call allows you to update an existing Folder's properties.

On the Cloud, this API is available via SSL-secured HTTPS connection using the REST PUT verb.
The format query string parameter controls the desired response format. Specify either XML or JSON.

/api/v2/folder?format=xml/json

You may use either JSON or XML formats in your PUT request.
You indicate this by setting the ContentType HTTP header as "application/json" or "application/xml".
If no ContentType is specified, XML format is assumed.

All XML formatted requests must specify the following XML namespace in the data source root element:
xmlns:i="http://www.w3.org/2001/XMLSchema-instance"

Parameters
The POST Folder API allows you to create a new folder in your company account.
The required and optional parameters for a POST call to the Folder API are outlined below.

Name Type Description Required

Id String GUID of the folder you'd like to update. ✓
Name String Name of the folder you'd like to update.
ExternalId String External ID of the form you'd like to update.
IsRestricted Boolean Whether or not this Folder restricts user access to its contents.
Restrict access to a specific User Group identifier. This only
allows access to users in the selected group. Users in this
RestrictToGroup String
Group will also be able to access all items not assigned to any
Groups.
Description String Description of the Folder.
GUID of the object to be included in the folder, ie. Screen or
Items Array
Data Source.
Your unique Company ID is found on the Organization Setup
CompanyId Integer ✓
page of the secure website.
Your unique Integration Key is found on the Organization Setup
IntegrationKey String ✓
page of the secure website.

11 / 12
 7/15/24, 6:14 PM

KeyId String The ID of the linked item.

Type String ['Screen', 'Doc', 'DataSource', 'Folder', 'TaskTemplate']

Example
Given that the API is REST-based, you can access the API directly via your web browser to test or by using Postman API
Platform.

The below example demonstrates how to update an existing folder using a PUT Folder API call.

Request URL
https://secure.formsonfire.com:443/api/v2/folder

Request Body
{
"Id": "",
"Name": "",
"ExternalId": "",
"IsRestricted": false,
"RestrictToGroup": "",
"Description": "",
"Items": [
{
"KeyId": "",
"Type": ""
}
],
"CompanyId": 0,
"IntegrationKey": ""
}

12 / 12