Skip to main content
GET
/
v1
/
customers
/
{customerId}
/
form
Get all customer forms for a customer
curl --request GET \
  --url https://dev.flextell.ai/api/v1/customers/{customerId}/form \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Tenant: <x-tenant>'
{
  "success": "<string>",
  "data": {
    "current_page": 2,
    "data": [
      {
        "id": 123,
        "template_id": 123,
        "customer_id": 123,
        "token": "<string>",
        "assigned_by_user_id": 123,
        "completed_at": "2023-11-07T05:31:56Z",
        "meta": [
          "<unknown>"
        ],
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "deleted_at": "2023-11-07T05:31:56Z",
        "is_ai_generated": true,
        "filled_by_user_id": 123
      }
    ],
    "first_page_url": "<string>",
    "from": 2,
    "last_page_url": "<string>",
    "last_page": 2,
    "links": [
      {
        "url": "<string>",
        "label": "<string>",
        "active": true
      }
    ],
    "next_page_url": "<string>",
    "path": "<string>",
    "per_page": 1,
    "prev_page_url": "<string>",
    "to": 2,
    "total": 1
  }
}

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