Skip to main content
GET
Get all customer forms for a customer

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

X-Tenant
number
required

Tenant identifier. Send the Tenant ID in the X-Tenant header to scope API requests to a specific tenant.

Path Parameters

customerId
integer
required

The customer identifier

Query Parameters

per_page
integer | null

The number of items per page.

Required range: 1 <= x <= 100
page
integer | null

The page number.

Required range: x >= 1
sort_by
enum<string> | null

The field to sort by.

Available options:
id,
status,
completed_at,
created_at,
updated_at
sort_order
enum<string> | null

The sort direction (asc or desc).

Available options:
asc,
desc
status
enum<string>

Filter by status.

Available options:
pending,
completed,
reviewed
template_id
integer | null

Filter by template ID.

Required range: x >= 1
trashed
boolean | null

Include only soft-deleted records.

Response

success
string
required
data
object
required