Skip to main content
GET
List files

Authorizations

x-conveyour-token
string
header
required

Your API key token. Contacts endpoints require a Server-only — Full API key — see Authentication.

Query Parameters

folder_id
string

Filter to files in a specific folder. Pass null to return files with no folder assigned.

pid
string

Filter to a file by its public ID (PID).

contact_id
string

Filter to files associated with a specific contact.

type
string

Filter by file type.

mime_types
string[]

Filter by one or more MIME types. Pass as repeated query params: mime_types[]=application/pdf&mime_types[]=image/png.

query
string

Search by filename (case-insensitive substring match).

page
integer

Page number (1-based). When set, enables paginated response. Omit for a flat list (up to 1000 records).

per_page
integer

Items per page when page is set. Default: 50.

teams[]
string[]

Team scope for the request, as one or more team ObjectIds. The brackets are required: PHP keeps only the last value for a repeated plain key, so teams=A&teams=B silently resolves to B alone. On requests with a JSON body you may send teams (no brackets) in the body instead.

Values that are not valid ObjectIds are silently ignored — a mistyped team ID behaves as if no team was sent. See the teams section of the API conventions guide.

Response

Success.

The common response envelope shared by all ConveYour endpoints.

status
enum<string>

ok on success, failed on error.

Available options:
ok,
failed
message
string

Human-readable description of the result.

data
object

A file record. Returns the stored attributes and adds url, user_name, contact_name, folder_id and folder_name.