Skip to content

List customers

GET
/api/v1/customers

Customers are the external organisations that send questionnaires and RFPs. Sorted by name. Customers are read-only through the API.

NameType
page
integer
default: 1 >= 1

Page number; 20 records per page

query
string

Case-insensitive substring filter on the customer name

200

Customers

Response body
Media typeapplication/json
object
customers
Array<object>
object
id
string
name
string
questionnaires_count
integer
rfps_count
integer
created_at
string format: date-time
updated_at
string format: date-time
pagination
object
current_page
integer
total_pages
integer
total_count
integer
items_per_page
integer
from
integer | null

1-based index of the first record on this page

to
integer | null

1-based index of the last record on this page