---
title: "List contacts"
method: GET
path: "/v1/contacts/"
tags: ["contacts"]
---

# List contacts

`GET /v1/contacts/`

## Request

- Base URL: `https://api.wraps.dev`
- URL: `https://api.wraps.dev/v1/contacts/`
- Auth: HTTP bearer

Lists contacts with pagination and filtering

## Query parameters

- `page` string
- `pageSize` string
- `emailStatus` union
  - string
  - string
  - string
  - string
  - string
- `smsStatus` union
  - string
  - string
  - string
  - string
- `search` string
- `preferredChannel` union
  - string
  - string

## Response `200`

- object
  - `contacts` object[], required
    - `id` string, required: Contact ID
    - `externalId` string, required: Caller-supplied external ID
    - `email` string, required: Email address
    - `phone` string, required: Phone number
    - `firstName` string, required: First name
    - `lastName` string, required: Last name
    - `company` string, required: Company name
    - `jobTitle` string, required: Job title
    - `emailStatus` string, required: Email subscription status
    - `smsStatus` string, required: SMS subscription status
    - `preferredChannel` string, required: Preferred communication channel
    - `properties` object, required
    - `emailsSent` number, required: Number of emails sent
    - `emailsOpened` number, required: Number of emails opened
    - `emailsClicked` number, required: Number of emails clicked
    - `smsSent` number, required: Number of SMS sent
    - `smsClicked` number, required: Number of SMS clicked
    - `createdAt` string, date-time, required: Creation timestamp
    - `updatedAt` string, date-time, required: Last update timestamp
  - `total` number, required: Total number of contacts matching filter
  - `page` number, required: Current page number
  - `pageSize` number, required: Number of items per page
  - `totalPages` number, required: Total number of pages

## Other responses

- `400`: Malformed request — unparseable body or an invalid parameter.
- `401`: Missing, malformed, or revoked credentials. Send `Authorization: Bearer <api key>`.
- `403`: Authenticated, but the resource belongs to another organization.
- `404`: No such route, or no such resource in this organization.
- `422`: The request parsed but failed schema validation.
- `429`: Rate limit exceeded. Wait for the window named by the RateLimit headers.
- `500`: Unexpected server failure. Safe to retry with backoff; quote `requestId` if it persists.

---

[API](https://skmtc.dev/wraps/apis/wraps-platform-api.md) · [All operations](https://skmtc.dev/wraps/apis/wraps-platform-api/llms.txt) · [OpenAPI document](https://skmtc.dev/wraps/apis/wraps-platform-api/revisions/12116fb21af7?raw)