Skip to main content
GET
List submissions

Authorizations

x-conveyour-token
string
header
required

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

Query Parameters

obj_id
string

Filter submissions by submission collection (form) ID.

obj_name
string

Alternative to obj_id — filter by form name/slug.

Text search across submission data.

page
integer

Page number (1-based). When omitted or 0, returns a flat array with no pagination wrapper. When 1 or higher, returns a paginated envelope. Default: 0.

per_page
integer

Records per page when page ≥ 1. Default: 100.

format
string

Pass csv to download as a CSV file.

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

The response payload — an object or an array depending on the endpoint.