List Documents
Returns all Documents available in the user's ForceManager implementation database.
You will only receive the List of Documents 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?page=PAGE_NUMBER
You can apply filters.
e.g.
https://api.forcemanager.com/api/v4/documents?where= param1=value AND/OR param2=value2
You can filter Documents by dateCreated or dateUpdated, or size for example.
You can also organise and view the results for Documents 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?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?lang=VALUE
RESPONSE
This endpoint returns information about all Documents 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 Documents attributes:
| Attribute | Type | Description |
|---|---|---|
| --- | --- | --- |
| accountId | Object, Null | The ID of the Account that Document belongs to (see Accounts resource) |
| activityId | Object, Null | The ID of the Activity that Document belongs to (see Activities resource) |
| billboardId | Object, Null | The ID of the News that Document belongs to (see News resource) |
| campaignId | Object, Null | The ID of the Campaign that Document belongs to (see Campaigns resource) |
| contactId | Object, Null | The ID of the Contact that Document belongs to (see Contacts resource) |
| opportunityId | Object, Null | The ID of the Opportunity that Document belongs to (see Opportunities resource) |
| salesOrderId | Object, Null | The ID of the Order that Document belongs to (see Orders resource) |
| folderId | Object, Null | The Folder Id that the Document belongs to (see Folders resource) |
| formId | Object, Null | The ID of the Form that Document belongs to to (see Forms resource) |
| dateCreated | String | Date and time when the Document was created |
| dateDeleted | String | Date and time when the Document was deleted |
| dateUpdated | String | Date and time when the Document was last updated |
| deleted | boolean | If true, the Document has been deleted and archived |
| description | String | The Document name. The user is gonna see this name. |
| extension | String | The Document extension (docx, pptx, pdf, xlsx, jpg, png...) |
| extId | String | External ID of the Document from a third party system (ERP, CRM, Accounting System) |
| hidden | Boolean | True if the Document is visible. Otherwise, false |
| id | Integer | Unique identifier for the Document in ForceManager |
| name | String | The original Document name. This is the stored name in ForceManager database |
| level | Integer | Defines the visibility of the Document. Set from 1 to 5 being 5 the highest level of permission |
| link | String | The url to retrieve the Document |
| userId | Integer | The ID of the User that upload the Document |
| salesRepIdCreated | Integer | Unique identifier of the user who created the Document |
| salesRepIdDeleted | Integer | Unique identifier of the user who deleted the Document |
| salesRepIdUpdated | Integer | Unique identifier of the user who updated the Document |
| size | Integer | The file size in bytes |
| carrousel | Boolean | True if the Document is a Product Carousel (see Carousels resource) |
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
- Auth: API key in header X-Session-Key
Headers
Response
List Documents
Changes
No recorded changes to this operation across all 1 revision of this API.