Skip to main content
GET
List files

Authorizations

Authorization
string
header
required

A Parley API key.

Query Parameters

projectId
string

List this project's files. Pass exactly one of projectId, accountId, contactId, intakeId, or library.

Minimum string length: 1
accountId
string

List this account's files. Pass exactly one of projectId, accountId, contactId, intakeId, or library.

Minimum string length: 1
contactId
string

List this contact's files. Pass exactly one of projectId, accountId, contactId, intakeId, or library.

Minimum string length: 1
intakeId
string

List this intake's files. Pass exactly one of projectId, accountId, contactId, intakeId, or library.

Minimum string length: 1
library
any

true for the organization's Library. Pass exactly one of projectId, accountId, contactId, intakeId, or library.

folderId
string

List inside this folder, which must be in the location. Omit to start at the top level.

Minimum string length: 1
recursive
boolean
default:false

Include everything below the starting point, not just the files and folders directly in it.

Case-insensitive. Only files and folders whose name contains this text.

Minimum string length: 1
type
enum<string>

Only files, or only folders.

Available options:
file,
folder
createdSince
string

Only records created at or after this time. An ISO 8601 date (YYYY-MM-DD, read as UTC midnight) or date-time.

createdBefore
string

Only records created before this time. An ISO 8601 date (YYYY-MM-DD, read as UTC midnight) or date-time.

updatedSince
string

Only records last updated at or after this time. An ISO 8601 date (YYYY-MM-DD, read as UTC midnight) or date-time.

updatedBefore
string

Only records last updated before this time. An ISO 8601 date (YYYY-MM-DD, read as UTC midnight) or date-time.

sort
enum<string>
default:-createdAt

Sort order: a field name, prefixed with - for descending. Defaults to -createdAt.

Available options:
name,
-name,
createdAt,
-createdAt,
updatedAt,
-updatedAt
cursor
string

Opaque cursor from nextCursor. Pass the same filters and sort. Omit for the first page.

Minimum string length: 1
limit
integer
default:50

Maximum number of items to return.

Required range: 1 <= x <= 250

Response

OK

data
object[]
required

A file or a folder, told apart by type.

Example:
nextCursor
string | null
required

Cursor for the next page, or null on the last page.