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

# List contacts

`GET /v1beta/contacts`

## Query parameters

- `limit` integer
- `offset` integer
- `order` string
- `order_by` string
- `email_pattern` string
- `last_name_pattern` string
- `company_name_pattern` string
- `username_pattern` string
- `role` string
- `with_additional_data` boolean

## Response `200`

A successful response.

- ContactListContactsResponse
  - `code` integer
  - `data` ContactListContactsResponseData
    - `results` PersoncontactContact[]
      - `additional_data` ContactAdditionalData
        - `birth_city` string
        - `birth_date` string
        - `social_security_number` string
      - `address` ContactAddress
        - `city` string
        - `country` string
        - `number` string
        - `state` string
        - `street` string
        - `suffix` string
        - `zipcode` string
      - `api_access_enabled` boolean
      - `api_client_ip_list` ContactClientIpList
        - `allow` string[]
        - `deny` string[]
      - `auth_type` string
      - `comments` string
      - `company_name` string
      - `email` string
      - `hash_changed_at` string
      - `id` integer
      - `is_active` boolean
      - `last_api_call_at` string
      - `last_login_at` string
      - `locale` string
      - `name` ContactName
        - `first_name` string
        - `full_name` string
        - `initials` string
        - `last_name` string
        - `prefix` string
      - `password_change_declined_at` string
      - `password_changed_at` string
      - `phone` ContactPhone
        - `area_code` string
        - `country_code` string
        - `subscriber_number` string
      - `rcp_client_ip_list` ContactClientIpList
        - `allow` string[]
        - `deny` string[]
      - `reseller_id` integer
      - `role` string
      - `secret_key` string
      - `username` string
      - `vat` string
    - `total` integer
  - `desc` string
  - `maintenance` boolean
  - `warnings` ErrorWarning[]
    - `code` integer
    - `data` string
    - `desc` string

## Other responses

- `default` — (empty)

---

[API](https://skmtc.net/openprovider/apis/rest-api.md) · [All operations](https://skmtc.net/openprovider/apis/rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/openprovider/rest-api/revisions/55b7a0062507/schema)