List Folders
Returns all Folders available in the user's ForceManager implementation database.
You will only receive the List of Folders after first providing the Session Key. To know how you can obtain the Session Key, go to Authentication.
HEADERS
| Parameter | Value | Description |
|---|---|---|
| Content-Type | application/json | Language in which all request and response bodies are encoded |
| Accept | */* | Any data of whatever mime type is accepted |
| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |
| Count | {number} | The number of records to return in each page of results. The default page limit is 50 |
| ExtraFieldDescription | {number} | If equal to "0", the response returns only the value of each Extra Fields, if equal to "1" also the description is returned |
REQUEST
You can apply filters, organise and choose the language and pagination using any query string parameter in SQL. Query string parameters appear after a question mark in the endpoint followed by the parameters and their values. In the query string, each parameter is listed one right after the other with an AND separating them. The order of the parameters does not matter.
| Parameter | Type | Description |
|---|---|---|
| page | Integer | Define the pagination data for the returned objects |
| param1, param2... | String, Integer | Apply filters using any query string parameter in SQL |
| order | String | organise and view the results for a specific attribute in descendent order - at the top the most recent results while the oldest results will be down the list |
| lang | String | Define the language in which you want to receive the response |
You can define the pagination data for the returned objects. The default page number is 0, otherwise you can optionally determine the page number.
e.g.
https://api.forcemanager.com/api/v4/documents/folders?page=PAGE_NUMBER
You can apply filters.
e.g.
https://api.forcemanager.com/api/v4/documents/folders?where= param1=value AND/OR param2=value2
You can filter Folders by dateCreated or dateUpdated, or entityId for example.
You can also organise and view the results for Folders in descendent order - at the top, the most recent results while the oldest results will be down the list.
e.g.
https://api.forcemanager.com/api/v4/documents/folders?order=VALUE
In the request, and using query string parameters, you can also define the language in which you want to receive the response.
e.g.
https://api.forcemanager.com/api/v4/documents/folders?lang=VALUE
RESPONSE
This endpoint returns information about all Folders available in the database.
If you didn't apply any page or count number in the header the default number of records in the response is 50.
List of the supported Folders attributes:
| Attribute | Type | Description |
|---|---|---|
| folderId | Integer | The folder that contains this folder. If value is -1 means the folder is in the directory root, otherwise, means the folder belongs to another folder |
| entityId | String | The ID of the entity associated to the folder. Entities can be: accounts, contacts, opportunities, etc. |
| id | Integer | Unique identifier for the Folder in ForceManager |
| name | String | The Folder name |
| level | Integer | Defines the visibility of the Folder. Set from 1 to 5 being 5 the highest level of permission |
| restrictSucursales | Boolean | True if not all the environment can see this Folder, otherwise False |
| salesRepIdCreated | Integer | Unique identifier of the user who created the Folder |
| salesRepIdDeleted | Integer | Unique identifier of the user who deleted the Folder |
| salesRepIdUpdated | Integer | Unique identifier of the user who updated the Folder |
| dateCreated | String | Date and time when the Folder was created |
| dateDeleted | String | Date and time when the Folder was deleted |
| dateUpdated | String | Date and time when the Folder was last updated |
| delete | boolean | If true, the Folder has been deleted and archived |
RESPONSE CODES
| Status | Description |
|---|---|
| 200 OK | Shows if operation succeeded |
| 400 Bad Request | Shows when an invalid request or the requested service is not available |
Request
- Base URL: https://api.forcemanager.com/api/v4
- URL: https://api.forcemanager.com/api/v4/documents/folders
- Auth: API key in header X-Session-Key
Headers
Response
List Folders
Changes
No recorded changes to this operation across all 1 revision of this API.