GET Folder

TABLE OF CONTENTS

Parameters
Example

ADDITIONAL INFO

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
CompanyId	Integer	Your unique Company ID is found on the Organization Setup page of the secure website.	✓
IntegrationKey	String	Your unique Integration Key is found on the Organization Setup page 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.

Request URL

https://secure.formsonfire.com.com:443/api/v2/folder?CompanyId=60XXX&IntegrationKey=995XXXXXXXXXXXXXXXXXXXXXXXXXXXX&Name=Test%20Apps

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"
      },
      {
        "KeyId": "46bXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
        "Type": "Screen"
      },
      {
        "KeyId": "1e6XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
        "Type": "Screen"
      }
    ],
    "CompanyId": 6XXXX
  }
}

English

Parameters

Example