curl -H "X-API-KEY: your_api_key" \
"https://www.gomry.com/api/v1/contacts?page=1&page_size=50"
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();
{
"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
}
}
Contacts
List Contacts
List contacts for your organization with pagination and filtering
GET
/
contacts
curl -H "X-API-KEY: your_api_key" \
"https://www.gomry.com/api/v1/contacts?page=1&page_size=50"
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();
{
"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
}
}
List Contacts
Returns a paginated list of contacts belonging to your organization.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.Query Parameters
integer
default:"1"
Page number (starts at 1).
integer
default:"50"
Number of contacts per page. Maximum:
200.string
default:"active,inactive"
Comma-separated list of statuses to include.Allowed values:
active, inactive.Example: ?status=activestring
Search contacts by email prefix. Case-insensitive. Matches the resolved
email — including emails backfilled from the contact’s linked user account.Example:
?search=jane@Response
array
Show Contact object
Show Contact object
string
Unique contact identifier
string | null
First name
string | null
Last name
string | null
Email address
string | null
Phone number
string
Contact status (
active or inactive)string | null
Job title
string | null
Company name
string | null
University name
string | null
Gender
string | null
Birthday
string | null
Location
string | null
LinkedIn URL
string | null
Instagram handle
string | null
Twitter handle
string | null
GitHub handle
string | null
Website URL
string[]
Array of tags
string | null
ISO 8601 creation timestamp
string | null
ISO 8601 last-updated timestamp
object
curl -H "X-API-KEY: your_api_key" \
"https://www.gomry.com/api/v1/contacts?page=1&page_size=50"
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();
{
"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
}
}