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

# contacts

`GET /contacts`

## Request

- Base URL: `https://earthnode-dev.vopay.com/api/v2`
- URL: `https://earthnode-dev.vopay.com/api/v2/contacts`
- Auth: none declared

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, required: True if the request was successful, false if it failed
  - `ErrorMessage` string, required: Contains a description of the error if the request failed
  - `Contacts` object, required: Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... Empty {} when no items. Collection of contacts associated with the VoPay account
    - `0` object: Contact information
      - `ContactID` number, required: Unique ID of the contact
      - `ContactName` string, required: Name associated with this contact
      - `EmailAddress` string, required: Email address associated with this contact
      - `PhoneNumber` string, required: Phone number associated with this contact
      - `IsActive` string, required: Active status of the contact
      - `Nationality` string, required: The contacts nationality
      - `Currency` string, required: 3 character currency code for the contact
  - `Pagination` object: Pagination metadata
    - `TotalRecords` string, required: Total number of contact records in that search range.
    - `Offset` string, required: Use this parameter to set the starting point in the dataset.
    - `Limit` string, required: Limit the number of records that are returned.

---

[API](https://skmtc.dev/vopay/apis/contact.md) - [All operations](https://skmtc.dev/vopay/apis/contact/llms.txt) - [OpenAPI document](https://skmtc.dev/vopay/apis/contact/revisions/0ca99d945e63?raw)