Skip to content

Get a customer

GET
/api/v1/customers/{id}

Embeds a summary of every questionnaire and RFP linked to the customer. Fetch each one by id for the full record.

NameType
id
required
string

The record’s prefixed ID

200

The customer, with questionnaires embedded

Response body
Media typeapplication/json
object
id
string
name
string
questionnaires_count
integer
rfps_count
integer
created_at
string format: date-time
updated_at
string format: date-time
questionnaires
Array<object>

A questionnaire or RFP linked to a customer

object
id
string
title
string
state
string

The questionnaire or RFP state; see the full schema for allowed values

deadline
string | null format: date
created_at
string format: date-time
web_link
string format: uri
rfps
Array<object>

A questionnaire or RFP linked to a customer

object
id
string
title
string
state
string

The questionnaire or RFP state; see the full schema for allowed values

deadline
string | null format: date
created_at
string format: date-time
web_link
string format: uri

404

No such record in this account

Response body
Media typeapplication/json
object
error
object
code
string

A stable machine-readable code

message
string
details
Array<string>

Present on validation errors; one entry per failed validation