---
title: "contacts"
method: GET
path: "/contacts"
tags: ["Contact Endpoints"]
---

# contacts

`GET /contacts`

This endpoint is used to get a list of contacts associated with the account.

## Query parameters

- `AccountID` string, required
- `Key` string, required
- `Signature` string, required
- `ContactID` string
- `Limit ` integer
- `Offset ` integer
- `SearchText` string

## Response `200`

- object
  - `Success` boolean — True if the request was successful, false if it failed
  - `ErrorMessage` string — Contains a description of the error if the request failed
  - `Contacts` object — Collection of contacts associated with the VoPay account
    - `0` object — Contact information
      - `ContactID` number — Unique ID of the contact
      - `ContactName` string — Name associated with this contact
      - `EmailAddress` string — Email address associated with this contact
      - `PhoneNumber` string — Phone number associated with this contact
      - `IsActive` string — Active status of the contact
      - `Nationality` string — The contacts nationality
      - `Currency` string — 3 character currency code for the contact
  - `Pagination` object — Pagination metadata
    - `TotalRecords` string — Total number of contact records in that search range.
    - `Offset` string — Use this parameter to set the starting point in the dataset.
    - `Limit` string — Limit the number of records that are returned.

---

[API](https://skmtc.net/vopay/apis/accounts.md) · [All operations](https://skmtc.net/vopay/apis/accounts/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/vopay/accounts/versions/7033bd231ec7/schema)