GET Folder (Search)

GET Folder (Search)


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.



NameTypeDescriptionRequired
CompanyId
Integer
Your unique Company ID found on the Organization Setup page of the secure website.
✓
IntegrationKey
String
Your unique Integration Key found on the Organization Setup page of the secure website.
✓
Name
String
Folder name to search for.
ExternalId
String
Folder external ID to search for.
PageNo
IntegerThe page number from which to start reading results (0 based).

PageSize
Integer
The page size (number of rows) to return. Maximum allowable value is 250.

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 example below demonstrates a simple request returning all Folders from a specific company account.

​

Request URL
https://eforms.mobileform.net: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
}


    • Related Articles

    • GET Folder

      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. ...

    • GET Usergroup (Search)

      TABLE OF CONTENTS Parameters Example This API allows you to find all user groups matching the given parameters. This API is available via SSL-secured HTTPS connection on the Cloud using the REST GET verb. The format query string parameter controls ...

    • GET Screen (Map Search)

      The GET Screen (Map Search) API returns the Published version of matching Map Screens or all versions of a single specified Map Screen. On the Cloud, this API is available via SSL-secured HTTPS connection using the REST GET verb. The format query ...

    • GET Screen (Search)

      TABLE OF CONTENTS Parameters Example The Screen API returns the Published version of matching Forms or all versions of a specified Form. On the Cloud, this API is available via SSL-secured HTTPS connection using the REST GET verb. The format query ...

    • GET Screen (Iconboard Search)

      TABLE OF CONTENTS Parameters Example The GET Screen (Iconboard Search) API returns the Published version of the matching Icon Boards or all versions of a specified Icon Board. On the Cloud, this API is available via SSL-secured HTTPS connection using ...