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

# Search contacts

`GET /v1/Contacts`

Search for one or more contacts.

## Query parameters

- `search.contact_id` integer[]
- `search.customer_id` integer[]
- `search.contact_type_id` integer[]
- `search.name` string[]
- `search.email` string[]
- `search.mobile` string[]
- `search.company` string[]
- `search.title` string[]
- `search.phone` string[]
- `search.fax` string[]
- `search.created_date_start` string, date-time
- `search.created_date_end` string, date-time
- `search.page_size` integer
- `search.page` integer
- `search.sort` string

## Response `200`

OK

- RevWebAPIModelsGetOrSearchOfRevAppSearchModelsResponseOfRevAppModelsContact
  - `ok` boolean
  - `has_more` boolean — Helper for pagination. Indicates there are more records returned.
  - `record_count` integer — Total number of records found by the search.
  - `records` RevAppModelsContact[] — List of records returned.
    - `contact_id` integer — Primary identifier for this contact.
    - `name` string, required — Name of contact. Can be full or partial name.
    - `email` string — Email address or addresses for which to contact this person. (for multiple emails, separate by comma)
    - `company` string — Name of the company this person works for.
    - `customer_id` integer — Foreign identifier for the account this contact is associated with.
    - `agent_id` integer — Foreign identifier for the agent this contact is associated with.
    - `created_date` string, date-time — Date and time this contact was created.
    - `title` string — A title for which this contact holds.
    - `position` string — A position for which this contact holds.
    - `fax` string — Telephone number to use for facsimile transmission.
    - `phone` string — Primary phone number that can be used to contact the person.
    - `comments` string — Comments or notes about the person for internal use.
    - `mobile` string — A mobile telephone number from which the person can be contacted.
    - `contact_type_id` integer — Foreign identifier for the type of contact represented.
    - `fields` RevAppModelsFieldValue[] — List of custom fields and their values.
      - `field_id` integer — Primary identifier for this custom field.
      - `label` string — User-defined identifier representing the custom field.
      - `value` string — Value of the custom field.
      - `links` RevAppComponentsLink[]
        - `rel` string
        - `href` string
    - `address` RevAppModelsContactAddress
      - `line_1` string — First line of address. (i.e. Street Number, Street Name, Post Direction)
      - `line_2` string — Second line of address. (i.e. Apt, Unit, Floor)
      - `city` string — City or township of the address.
      - `state_or_province` string — State if USA, Province for some other countries.
      - `postal_code` string — Zip for USA (5-digit), can be longer for other countries.
      - `postal_code_extension` string — Zip+4 for USA
      - `links` RevAppComponentsLink[]
        - `rel` string
        - `href` string
    - `links` RevAppComponentsLink[]
      - `rel` string
      - `href` string

## Other responses

- `500` — InternalServerError

---

[API](https://skmtc.net/rev-io/apis/rev-io-api.md) · [All operations](https://skmtc.net/rev-io/apis/rev-io-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/rev-io/rev-io-api/versions/135571434f6c/schema)