HomeGuidesRecipesAPI ReferencePython SDK
Alation Help Center
API Reference

Retrieve documents

Retrieve documents from the server, along with details including title, description, and ID. Add the id parameter to only retrieve details of a specific document; an optional values parameter can be supplied to return only the specified set of fields of the request. You can only retrieve documents for which you have view or edit permissions.

Query Params
integer

The ID of the document

integer
Defaults to 1

The ID of the folder whose documents you want to get.

integer
Defaults to 1

The ID of the Document Hub whose documents you want to get.

integer
Defaults to 100

Specifies the number of documents to be fetched in one paginated request. The response may have an X-Next-Page URL parameter in the header to fetch the next set of rules or page. The default maximum value is 1000, and can be configured via alation.document_api.max_payload_size.

integer
Defaults to 0

Specifies the number of rules to be skipped in one request. Used together with limit parameter to fetch paginated requests. This is automatically set in the X-Next-Page response header if present.

string

Filter on all textual fields of documents

boolean
Defaults to false

Will return only deleted documents when set to True.

string

Specifies a comma-separated list of fields to be included in the response. When provided, the API will return only the specified set of fields for each object in the response. If not supplied, the API will return all fields by default.

Responses

Language
Credentials
URL
Choose an example:
application/json