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

# List all existing contacts

`GET /v1/contacts`

## Query parameters

- `Id` integer
- `DepartmentId` integer
- `CompanyId` integer
- `FullName` string
- `FirstName` string
- `LastName` string
- `Email` string
- `Phone` string
- `GroupIds` string
- `Address` string
- `State` string
- `City` string
- `Town` string
- `CountryCode` string
- `Job` string
- `Status` string — <p>Enum values:</p><ul><li><i>C = Customer</i></li><li><i>L = Lead</i></li><li><i>P = Prospect</i></li><li><i>O = Lost</i></li><li><i>R = Reseller</i></li><li><i>T = Partner</i></li><li><i>S = Supplier</i></li></ul>
- `Blocked` integer
- `FromCreatedDate` string
- `ToCreatedDate` string
- `CustomFields` object
- `Q` string
- `Fields` string
- `DepartmentScope` DepartmentPageSelection — Selects departments for a page-level query. The query-string value can be `all` or a comma-separated list of positive department IDs, such as `12,34`.
- `ViewType` 0 | 1 — <p>Enum values:</p><ul><li><i>0 = List</i></li><li><i>1 = Kanban</i></li></ul>
- `Page` integer
- `ItemsPerPage` integer
- `ReturnTotalItems` boolean
- `sortCol` string
- `sortDir` string
- `isExport` boolean

## Response `200`

OK

- ContactResponseModelQueryResult
  - `totalItems` integer
  - `items` ContactResponseModel[], nullable
    - `country` string, nullable
    - `openDeals` integer
    - `wonDeals` integer
    - `openTickets` integer
    - `resolvedTickets` integer
    - `id` integer
    - `departmentId` integer
    - `firstName` string, required
    - `lastName` string, nullable
    - `fullName` string, nullable
    - `email` string, email, nullable
    - `phone` string, nullable — Phone number of the contact, with country code, without leading + (plus) sign
    - `companyId` integer, nullable
    - `companyName` string, nullable
    - `groupIds` string, nullable — Contact group ids separated by commas
    - `countryCode` string, nullable — ISO Alpha-2 country code, see <a href="https://www.iban.com/country-codes">https://www.iban.com/country-codes</a>
    - `state` string, nullable
    - `city` string, nullable
    - `town` string, nullable
    - `zip` string, nullable
    - `address` string, nullable
    - `status` string, nullable — <p>Enum values:</p><ul><li><i>C = Customer</i></li><li><i>L = Lead</i></li><li><i>P = Prospect</i></li><li><i>O = Lost</i></li><li><i>R = Reseller</i></li><li><i>T = Partner</i></li><li><i>S = Supplier</i></li></ul>
    - `department` string, nullable
    - `job` string, nullable
    - `createdUserId` integer
    - `createdDate` string, date-time
    - `updatedUserId` integer
    - `updatedDate` string, date-time, nullable
    - `color` string, nullable — Contact's background color, only used if there's no PhotoUrl
    - `photoUrl` string, nullable — Contact's photo URL
    - `customFields` string, nullable — A stringified JSON object mapping custom field names to values Example: {"My Text Custom Field":"Field Value","My Numeric Custom Field":2}
    - `blocked` integer, nullable — Whether the contact is blocked. If true; emails, chats, calls etc. from this contact will be ignored.
    - `visitor` string, nullable — Contact's unique identifier for chat conversations
    - `isEmailAllowed` integer, nullable
    - `isCallAllowed` integer, nullable
    - `isSmsAllowed` integer, nullable
    - `isWaMarketingAllowed` integer, nullable — Read-only provider consent state; it is surfaced on the contact model for filtering but is deliberately excluded from contact editing.
    - `waUserId` string, nullable — Allows identity lookup to continue when Meta no longer exposes the phone number.
    - `waUsername` string, nullable — Provides a display fallback without replacing the contact's user-managed name.
    - `lastSeen` string, date-time, nullable
    - `lastContacted` string, date-time, nullable
    - `lastHeard` string, date-time, nullable

---

[API](https://skmtc.dev/infoset/apis/infoset-rest-api.md) · [All operations](https://skmtc.dev/infoset/apis/infoset-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/infoset/infoset-rest-api/revisions/f5bc39a1ac15/schema)