People

List contacts

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

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)

Query parameters

pageinteger

1-based page number.

per_pageinteger

Items per page.

company_idstring uuid

Only contacts of this company.

qstring

Case-insensitive match on first name, last name or email.

Response

Page of contacts.

Example response

{
  "data": [
    {
      "first_name": "Jane",
      "last_name": "Doe",
      "email": "jane@acme.com",
      "role": "Head of Events",
      "job_title": "Head of Events"
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 50,
    "total": 1234,
    "total_pages": 25
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.