---
title: "List contacts"
method: GET
path: "/people"
tags: ["People"]
---

# List contacts

`GET /people`

## Request

- Base URL: `https://joinways.app/api/v1`
- URL: `https://joinways.app/api/v1/people`
- Auth: one of:
  - HTTP bearer
  - OAuth 2 (authorization code, authorization URL `https://joinways.app/oauth/authorize`, token URL `https://joinways.app/api/oauth/token`, scopes: `mcp.read`)

Contacts of the workspace, newest first, with their company (`companies`). **Role permission:** none (any member).

## Query parameters

- `page` integer
- `per_page` integer
- `company_id` string, uuid
- `q` string

## Response `200`

Page of contacts.

- object: Envelope wrapping a page of results.
  - `data` Person[], required: The page of results (item type depends on the endpoint).
    - `id` string, uuid
    - `first_name` string, nullable
    - `last_name` string, nullable
    - `email` string, nullable
    - `phone` string, nullable
    - `role` string, nullable: Job title (stored name).
    - `job_title` string, nullable: Job title, same value as `role`.
    - `company_id` string, uuid, nullable
    - `companies` object, nullable: The company (list and `GET` only).
      - `id` string, uuid
      - `name` string
    - `notes` string, nullable
    - `enrichment_status` string, nullable
    - `enrichment_completed_at` string, date-time, nullable
    - `created_at` string, date-time, nullable
    - `updated_at` string, date-time, nullable
  - `pagination` object, required
    - `page` integer, required: Current 1-based page.
    - `per_page` integer, required: Items per page.
    - `total` integer, nullable, required: Total matching items across all pages (`null` only on a page past the last one, when unknown).
    - `total_pages` integer, nullable, required

## Other responses

- `401`: Missing, invalid, expired or revoked bearer token (`unauthorized`).
- `429`: Too many requests (`rate_limited`). `details.reason`: `per-ip`, `per-account-minute`, `per-account-day`, or `email_rate_limited` (email budget). Always carries `Retry-After`: wait that many seconds.

---

[API](https://skmtc.dev/joinways/apis/joinways-public-api.md) · [All operations](https://skmtc.dev/joinways/apis/joinways-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/joinways/apis/joinways-public-api/revisions/39e84309953e?raw)
