Get Folder

/folders/{id}

Get a single folder type.

Get Folder [GET]

Authorization: Admin, Web, Mobile, Portal

Parameters

  • includeFormsCount boolean (optional) Default: false Example:  includeFormsCount=true

    Whether to include the key for the number of forms within a folder.

  • includeFormsCompletedCount boolean (optional) Default: false Example:  includeFormsCompletedCount=true

    Whether to include the key for the number of forms completed within a folder.

  • includePrioritiesCount boolean (optional) Default: false Example:   includePrioritiesCount=true

    Whether to include the key for the number of high, medium, and low priorities within the forms on the folder.

  • includePrioritiesResolvedCount boolean (optional) Default: false Example:   includePrioritiesResolvedCount=true

    Whether to include the key for the number of resolved priorities within the forms on the folder.

  • includeAnswerFilesCount boolean (optional) Default: false Example:   includeAnswerFilesCount =true

    Whether to include the key for the number of files (photos) on the answers within the forms on the folder.

Response 200

Body
{
  "item": {
    "id": 32988,
    "num": FC908,
    "description": "Facility Checks",
    "folderType": {
      "id" :230,
      "name": "Quotes",
      "color": "9ff79f",
      "rowStatus": 1
    },
    "createdAt": "2015-08-08T08:30:00Z",
    "createdBy": {
      "id": 1000,
      "firstName": "Homer",
      "lastName": "Simpson"
    },
    "closed": true,
    "closedAt": "2015-08-08T08:30:00Z",
    "closedBy": {
      "id": 1000,
      "firstName": "Homer",
      "lastName": "Simpson"
    },
    "account": {
      "id": 6293,
      "name": "Alpha and Omega",
      "num": "AX89174",
      "address": "123 Elm Street NE",
      "city": "Springfield",
      "state": "IL",
      "zip": "80982",
      "country": "US"
    },
    "location": {
      "id": 108,
      "name": "1st Branch"
    },
    "schedules": [
      {
        "id": 90812,
        "userId": 2228,
        "scheduleFrom": "2015-07-08T08:30:00Z",
        "scheduleTo": "2015-07-09T09:30:00Z",
        "note": null
      },
      {
        "id": 90980,
        "userId": 2228,
        "scheduleFrom": "2015-08-08T08:30:00Z",
        "scheduleTo": "2015-08-09T09:30:00Z",
        "note": "show ID at entrance"
      }
    ],
    "locationId": 108,
    "folderTypeId": 230,
    "modifiedAt": "2015-08-08T08:30:00Z"
  }
}

Still need help? Contact Us Contact Us