> ## Documentation Index
> Fetch the complete documentation index at: https://docs.gomry.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List Contacts

> List contacts for your organization with pagination and filtering

# List Contacts

Returns a paginated list of contacts belonging to your organization.

<Note>
  `email`, `first_name`, and `last_name` are backfilled from each contact's linked user account when the contact record itself stores them empty. A value stored directly on the contact always takes precedence. No extra scope is required — this comes with `contacts:read`.
</Note>

## Query Parameters

<ParamField query="page" type="integer" default="1">
  Page number (starts at 1).
</ParamField>

<ParamField query="page_size" type="integer" default="50">
  Number of contacts per page. Maximum: `200`.
</ParamField>

<ParamField query="status" type="string" default="active,inactive">
  Comma-separated list of statuses to include.

  Allowed values: `active`, `inactive`.

  Example: `?status=active`
</ParamField>

<ParamField query="search" type="string">
  Search contacts by email prefix. Case-insensitive.

  Example: `?search=jane@`
</ParamField>

## Response

<ResponseField name="data" type="array">
  <Expandable title="Contact object">
    <ResponseField name="id" type="string">Unique contact identifier</ResponseField>
    <ResponseField name="first_name" type="string | null">First name</ResponseField>
    <ResponseField name="last_name" type="string | null">Last name</ResponseField>
    <ResponseField name="email" type="string | null">Email address</ResponseField>
    <ResponseField name="phone_number" type="string | null">Phone number</ResponseField>
    <ResponseField name="status" type="string">Contact status (`active` or `inactive`)</ResponseField>
    <ResponseField name="job_title" type="string | null">Job title</ResponseField>
    <ResponseField name="company" type="string | null">Company name</ResponseField>
    <ResponseField name="university" type="string | null">University name</ResponseField>
    <ResponseField name="gender" type="string | null">Gender</ResponseField>
    <ResponseField name="birthday" type="string | null">Birthday</ResponseField>
    <ResponseField name="location" type="string | null">Location</ResponseField>
    <ResponseField name="linkedin" type="string | null">LinkedIn URL</ResponseField>
    <ResponseField name="instagram" type="string | null">Instagram handle</ResponseField>
    <ResponseField name="twitter" type="string | null">Twitter handle</ResponseField>
    <ResponseField name="github" type="string | null">GitHub handle</ResponseField>
    <ResponseField name="website" type="string | null">Website URL</ResponseField>
    <ResponseField name="tags" type="string[]">Array of tags</ResponseField>
    <ResponseField name="created_at" type="string | null">ISO 8601 creation timestamp</ResponseField>
    <ResponseField name="updated_at" type="string | null">ISO 8601 last-updated timestamp</ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="pagination" type="object">
  <Expandable>
    <ResponseField name="total" type="integer">Total number of matching contacts</ResponseField>
    <ResponseField name="page" type="integer">Current page number</ResponseField>
    <ResponseField name="page_size" type="integer">Items per page</ResponseField>
    <ResponseField name="total_pages" type="integer">Total number of pages</ResponseField>
  </Expandable>
</ResponseField>

<RequestExample>
  ```bash cURL theme={null}
  curl -H "X-API-KEY: your_api_key" \
    "https://www.gomry.com/api/v1/contacts?page=1&page_size=50"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    "https://www.gomry.com/api/v1/contacts?page=1&page_size=50",
    { headers: { "X-API-KEY": "your_api_key" } }
  );
  const { data, pagination } = await response.json();
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  {
    "data": [
      {
        "id": "AbCdEfGhIjKlMnOpQrSt",
        "first_name": "Jane",
        "last_name": "Doe",
        "email": "jane@example.com",
        "phone_number": "+1234567890",
        "status": "active",
        "job_title": "Engineer",
        "company": "Acme Inc",
        "university": null,
        "gender": null,
        "birthday": null,
        "location": "New York",
        "linkedin": "https://linkedin.com/in/janedoe",
        "instagram": null,
        "twitter": null,
        "github": "janedoe",
        "website": null,
        "tags": ["vip", "speaker"],
        "created_at": "2025-03-01T00:00:00.000Z",
        "updated_at": "2025-06-01T00:00:00.000Z"
      }
    ],
    "pagination": {
      "total": 1,
      "page": 1,
      "page_size": 50,
      "total_pages": 1
    }
  }
  ```
</ResponseExample>
