Skip to content

GET /contacts

List contacts

GET /contacts#

List contacts

Returns a paginated list of contacts visible to the authenticated workspace.

Authentication#

  • bearerAuth (http, bearer)

Path parameters#

None.

Query parameters#

Name In Required Schema Example Description
q query No string — Full-text search across name and email

Headers#

None.

Responses#

Status Description Content type Schema Example
200 Paginated contact list application/json ContactListResponse —
401 — — —

Examples#

cURL#

curl -X GET "https://api.acme.dev/v1/contacts?q=example" \
  -H "Authorization: Bearer YOUR_TOKEN"

JavaScript#

const response = await fetch("https://api.acme.dev/v1/contacts?q=example", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
  },
});
const data = await response.json();
console.log(data);

TypeScript#

const response = await fetch("https://api.acme.dev/v1/contacts?q=example", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
  },
});
const data = await response.json();
console.log(data);

// Tip: import generated types from your OpenAPI client SDK.