Files

Get files

get
Authorizations
X-API-KEYstringRequired
Query parameters
pagenumber · nullableOptionalDefault: 1
limitnumber · nullableOptionalDefault: 10
includestringOptionalExample: user,account
targetTablestring · enumOptionalPossible values:
targetIdstringOptional
Responses
chevron-right
200

200

application/json
get
/clients/api/v1/files

Upload a file

post

Upload a file to the system. CLIENT portal only supports uploads to INDIVIDUALS.

Example curl request

curl -X POST 'https://dalmore-client-portal-api-prod.onrender.com/api/v1/files?name=test&category=application&targetId=individual_01j5tkg6k2fygr0x06fegt27aj' \
  --header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9' \
  --form 'file=@"/Users/local/Desktop/test.csv"'
Authorizations
X-API-KEYstringRequired
Query parameters
namestring · min: 1 · max: 100RequiredExample: file_name
categorystring · max: 50RequiredExample: application
labelstring · enumRequiredExample: OTHERPossible values:
targetIdone ofRequiredExample: individual_01kcrsny60fb9rjc8bbqc3b80c
stringOptional
or
stringOptional
metadatastring · min: 2 · max: 600000 · nullableOptional
Responses
post
/clients/api/v1/files

Links a file to a new resource

post
Authorizations
X-API-KEYstringRequired
Path parameters
idstringRequired
Body
targetIdstringRequiredExample: trades_01j6aqmtfyfwy9spjdcnh7yqk7
labelstring · enumOptionalExample: OTHERPossible values:
categorystring · min: 1 · max: 50Optional
Responses
post
/clients/api/v1/files/{id}/link

Unlinks a file to the parent resource

post
Authorizations
X-API-KEYstringRequired
Path parameters
idstringRequired
Body
objectOptional
Responses
post
/clients/api/v1/files/{id}/unlink

Get file by id

get
Authorizations
X-API-KEYstringRequired
Path parameters
idstringRequired
Responses
chevron-right
200

200

application/json
get
/clients/api/v1/files/{id}

Update file by id

patch
Authorizations
X-API-KEYstringRequired
Path parameters
idstringRequired
Body
namestring · max: 50Required
categorystring · max: 50Required
labelstring · enumRequiredExample: OTHERPossible values:
metadatastring · min: 2 · max: 600000 · nullableOptional
Responses
patch
/clients/api/v1/files/{id}

Preview (stream) a file by id

get
Authorizations
X-API-KEYstringRequired
Path parameters
idstringRequired
Responses
chevron-right
200

200

application/json
Responseany · nullable
get
/clients/api/v1/files/preview/{id}

No content

Last updated