Contendar Help

List customer

List customers for a project, newest first, with paging and filters.

GET /customers

Authentication

Send your API key as a bearer token. See Authentication .

Query parameters

ParameterTypeDefaultNotes
projectIdUUIDrequiredThe project to read.
pageinteger1The page number, starting at 1.
pageSizeinteger25Rows per page. The maximum is 100.
searchstringnoneFree text search across name, email, and company.
sourcestringnoneOne or more of import, nps, testimonial, manual, generic, as a comma separated list.
statusstringnonesubscribed or unsubscribed.

Response

{
  "data": [
    {
      "customerId": "c1a2b3c4-d5e6-4f70-8a9b-0c1d2e3f4a5b",
      "projectId": "8a7b6c5d-4e3f-2a1b-0c9d-8e7f6a5b4c3d",
      "name": "Dana Lang",
      "email": "dana@acme.com",
      "company": "Acme",
      "jobTitle": "Head of Growth",
      "industry": "SaaS",
      "avatarUrl": null,
      "socialHandle": null,
      "companyLogoUrl": null,
      "source": "manual",
      "status": "subscribed",
      "unsubscribedAt": null,
      "createdAt": "2026-08-25T08:30:00.000Z",
      "updatedAt": "2026-08-25T08:30:00.000Z"
    }
  ],
  "pagination": { "page": 1, "pageSize": 25, "total": 1, "totalPages": 1 }
}

Response fields

FieldTypeNotes
customerIdstringThe ID of the customer.
projectIdstringThe project the customer belongs to.
namestringThe customer name.
emailstring or nullThe customer email.
companystring or nullThe customer company.
jobTitlestring or nullThe customer job title.
industrystring or nullThe customer industry.
avatarUrlstring or nullA temporary URL for the customer avatar. It expires.
socialHandlestring or nullThe customer social handle.
companyLogoUrlstring or nullA temporary URL for the company logo. It expires.
sourcestringWhere the customer came from. One of import, nps, testimonial, manual, generic.
statusstringsubscribed or unsubscribed.
unsubscribedAtstring or nullWhen the customer unsubscribed, as an ISO date.
createdAtstringWhen the customer was added, as an ISO date.
updatedAtstringWhen the customer was last changed, as an ISO date.

Example

curl "https://app.contendar.com/api/v1/customers?projectId=YOUR_PROJECT_ID&status=subscribed&page=1&pageSize=25" \
  -H "Authorization: Bearer ck_your_key_here"

Related pages

Was this helpful?