---
title: "Get list items for all contacts"
method: GET
path: "/contacts/list"
tags: ["Contacts (People)"]
---

# Get list items for all contacts

`GET /contacts/list`

Get a list of all contacts and associated data in your Nutshell Instance, in a list item format. List items have additional fields attached to them for filtering purposes. Contacts are people that you do business with, and are referred to as 'People' in the Nutshell UI.

## Query parameters

- `filter` object — Filter the returned contacts based on various criteria. Use /rest/contacts/list/fields to get a full list of valid filter keys.
- `q` string
- `sort` string[]

## Response `200`

contacts list

- object
  - `meta` object — Information about the Nutshell instance making the request
    - `count` integer — The number of returned contacts
    - `total` integer — The total number of contacts in your Nutshell instance
    - `instanceId` string — The Nutshell instance ID
    - `siteId` string — Site ID for WebFX customers
  - `listItems` object[]
    - `htmlUrl` string — The link to the entity within the app.
    - `htmlUrlPath` string — The path to the entity within the app.
    - `avatarUrl` string — The URL of the entity's avatar image.
    - `initials` string — The initials of the entity, used as a fallback for the avatar image.
    - `id` string — The API ID of this entity, formatted {integer}-{entityType}
    - `primaryName` string
    - `primaryInfo` string
    - `relatedName` string
    - `relatedInfo` string
    - `relatedType` string
    - `relatedUrl` string
    - `relatedUrlPath` string
    - `primaryContact` string
    - `primaryAccount` string
    - `latlon` string
    - `mapUrl` string
    - `isDeleted` boolean
    - `fields` object[] — Various additional fields for the list item. View the example response for more details.
    - `description` string

---

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