PAparley
Files

List files

List the files and folders of one location, newest first by default: pass exactly one of projectId, accountId, contactId, intakeId, or library=true. Starts at the location's top level: pass folderId to list inside a folder, and recursive=true to include everything below. Returns 400 INVALID_REFERENCE when the location or folder doesn't exist or you can't see it.

get/files

Request

  • Base URL
    https://api.parley.so/v1
  • URL
    https://api.parley.so/v1/files
  • Auth
    HTTP bearer

Query parameters

projectIdstring

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

accountIdstring

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

contactIdstring

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

intakeIdstring

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

libraryunknown
folderIdstring

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

recursiveboolean

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

searchstring

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

type'file' | 'folder'

Only files, or only folders.

createdSincestring

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

createdBeforestring

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

updatedSincestring

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

updatedBeforestring

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

sort'name' | '-name' | 'createdAt' | '-createdAt' | 'updatedAt' | '-updatedAt'

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

cursorstring

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

limitinteger

Maximum number of items to return.

Response

OK

nextCursorstring nullable required

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

Changes

No recorded changes to this operation across all 2 revisions of this API.