---
title: "Get Contacts"
method: GET
path: "/contacts"
tags: ["Contacts"]
---

# Get Contacts

`GET /contacts`

## Request

- Base URL: `https://openapi.n3xt.io`
- URL: `https://openapi.n3xt.io/contacts`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/n3xt/apis/n3xt-api-documentation/docs/contacts/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieve a list of contacts for the authenticated user, each containing details such as the contact ID, nickname, contact type, and timestamps.
- This endpoint allows searching for contacts by nickname or other attributes.
- The results can be paginated using the limit and offset parameters.

## Query parameters

- `searchString` string
- `limit` number, double
- `offset` number, double
- `orderBy` 'createdAt' | 'updatedAt'
- `order` 'asc' | 'desc'

## Response `200`

A list of contacts was retrieved successfully.

- union
  - Contact[]
    - `id` string, required
    - `nickname` string, required
    - `contactType` 'wallet' | 'user' | 'business', required
    - `contactId` string, required
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
  - ErrorResponse
    - `error` string, required

## Other responses

- `400`: Bad Request - Invalid request parameters.
- `401`: Unauthorized - Invalid or missing authentication token.
- `404`: Not Found - No contacts associated with this user were found.
- `500`: An unexpected server error occurred while trying to retrieve the contacts.

---

[API](https://skmtc.dev/n3xt/apis/n3xt-api-documentation.md) - [All operations](https://skmtc.dev/n3xt/apis/n3xt-api-documentation/llms.txt) - [OpenAPI document](https://skmtc.dev/n3xt/apis/n3xt-api-documentation/revisions/c634c45cd5b4?raw)