NextGen APIs

GET /documents/r1/directories

Http Verb

GET

Url

/documents/r1/directories

Permissions required


Personally Identifiable Information (PII)

No

Sensitive Information

No

Last Modified Version

r1

Released since

2025 W2 (FSM 20.0)

Deprecated since


Removed since


Tech Tags

PAGINATION ORDERING-SERVER-SIDE

Business Logic

This API returns a list of directories filtered by input criteria.

Query String Parameters

Filter ℹ️

Field

Validations

Note

id


Collection of ids

version


Collection of ids

deleted



active


Collection of ids

draft



uuid


Collection of strings

name


Collection of strings

parentUuid


Collection of strings

uuidPath


Collection of strings

creationDate



creationDateCentral



editDate



editDateCentral



authorId


Collection of ids

editorId


Collection of ids

typeId


Collection of ids

startValidityDate



endValidityDate



system



originId


Collection of ids

Order ℹ️

Default Order

id (ASC)

Page ℹ️

Default.

Fields ℹ️

Default.

Header Parameters

Default.

Response documentation

Response payload fields

Field

Note

id


version


deleted


active


draft


uuid


name


parentUuid


uuidPath


creationDate


creationDateCentral


editDate


editDateCentral


authorId


editorId


typeId


startValidityDate


endValidityDate


system


originId


Response error codes

BASE_0001