tradevest.ai

Partner Documents

Get Partner Documents

get
/partner-documents

Get partner documents not connected to single customer. For example reports. By default, it returns last 20 documents. It is possible to send query parameters to adjust the result.

Authorizations
OAuth2clientCredentialsRequired
Token URL:
Query parameters
documentTypestring · enumOptional

Type of document. For example TERMS_AND_CONDITIONS.

Possible values:
startDatestring · date-timeOptional

Beginning of the range. Document create date time is after this parameter.

endDatestring · date-timeOptional

End of the range. Document create date time is before this parameter.

isValidbooleanOptional

Used to filter active documents.

cursorstringOptional

String value used for pagination

limitinteger · min: 1Required

Maximum number of items to return

Default: 20
Responses
get
/partner-documents

Get Partner Document

get
/partner-documents/{documentId}

Get single partner document for given documentId.

Authorizations
OAuth2clientCredentialsRequired
Token URL:
Path parameters
documentIdstring · uuidRequired

Id of document

Responses
get
/partner-documents/{documentId}

Download document file

get
/partner-documents/{documentId}/file

Download document file for given documentId.

Authorizations
OAuth2clientCredentialsRequired
Token URL:
Path parameters
documentIdstring · uuidRequired

Id of document

Responses
get
/partner-documents/{documentId}/file
No content

Last updated