v1

latestOpenAPI 3.0.02026-08-063524105.9 KB

Contacts

List contacts

List all contacts in a workspace. Optionally filter by contact list. Soft-deleted contacts are excluded by default. Use includeDeleted=true to include them. Returns 404 for unauthorized workspace access.

get/v1/contacts

Query parameters

workspaceIdstring uuid required

Filter contacts by workspace ID (required)

Example:789e4567-e89b-12d3-a456-426614174000

contactListIdstring uuid

Filter contacts by contact list ID

Example:456e4567-e89b-12d3-a456-426614174000

includeDeletedstring

Include soft-deleted contacts (default: false)

Example:false

Response

Array of contacts in the workspace

idstring uuid required

Unique contact identifier

workspaceIdstring uuid required

Workspace ID that owns this contact

contactListIdstring uuid nullable required

Contact list ID (null if not in a list)

firstNamestring nullable required

Contact first name

lastNamestring nullable required

Contact last name

emailstring email nullable required

Contact email address

phonestring nullable required

Contact phone number

createdAtstring date-time required

Contact creation timestamp

updatedAtstring date-time required

Contact last update timestamp

deletedAtstring date-time nullable required

Soft delete timestamp (null if active)

Example response

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "workspaceId": "789e4567-e89b-12d3-a456-426614174000",
    "contactListId": "456e4567-e89b-12d3-a456-426614174000",
    "firstName": "John",
    "lastName": "Doe",
    "email": "john.doe@example.com",
    "phone": "+1-555-123-4567",
    "createdAt": "2025-12-11T12:00:00Z",
    "updatedAt": "2025-12-11T12:00:00Z"
  }
]