Sign in

v1

latestOpenAPI 3.0.02026-07-24115101.2 MB
Contract - Files

Get a contract file by ID

Use this endpoint to retrieve a specific contract file by its ID.

get/contracts/{contract_id}/files/{file_id}

Path parameters

contract_idinteger required

The unique ID of the contract.

file_idinteger required

The ID of a file.

Query parameters

downloadboolean

If set to true, the file will be downloaded. The default value is false; in this case, only the file metadata will be returned.

download_asstring

If specified, the downloaded file will have this name. This parameter supports unicode.

Headers

x-oneflow-api-tokenstring required

The API key of your Oneflow account.

Response

Returns the requested contract file.

extensionstring nullable required

The file extension

idinteger required
namestring nullable required

The name of the file.

type'contract' | 'verification' | 'attachment' | 'pdf' | 'unknown' required

One of the contract file types.