Get all document folders or one by name.
Version 2.0.0
Endpoint
GET
undefined/document-folders
Copy
Returns all documentFolders in an array. When specifying a name, return just one (not in an array).
Query Parameters
- namestringdocumentFolder name. When provided returns one, otherwise returns all.
Body Parameters
Responses
successful operation.
Body
application/json
- object
- idstringAuto generated on create. Cannot chante.Example: f1
- namestringRequiredPOST – required - Must be unique, PUT – identifier – cannot be changed. Allowed characters: alphanumeric (a-z, A-Z, 0-9), space ' ', ampersand '&' , hyphen '-' , underscore '_' , slash '/' ,backslash, colon ':' , parenthesis '(' and ')', curly brackets '{' and '}', pound '#', apostrophe, comma ',', asterisk '*'. Use URL encoding when special signs are sent. Percentage sign is not allowed anywhere due to Azure bug.Example: contracts_folderLength: 256
- descriptionstringoptional - Provide a description for the documentFolder.Example: Customer ContractsLength: 256
- creationDatestringRead-only. The date the documentFolder was first created.Example: 2023-11-20
- lastUpdatedstringRead-only. The date the documentFolder was last updated.Example: 2024-03-08
- fieldsarray of objectsRequired
Defines the list of fields the customer can search by and their attributes.
Each item defines the search field name to be searched by, its association to groups and additional parameters defning the search.