Skip to main content
GET
List submission documents

Authorizations

x-conveyour-token
string
header
required

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

Path Parameters

id
string
required

The id identifier.

Query Parameters

field
string
required

The field name holding the DocuSeal configuration.

merge
boolean

When true (default), returns a single merged PDF. When false, returns individual document files.

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[]

Documents for the submitter, from getContactRelatedRemoteSubmitterDocuments(). These come from the remote e-signature provider; pass merge=false to receive them unmerged. Item fields are provider-defined and unverified.