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.

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&IntegrationKey=995XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

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
}