Contacts

List contacts

Retrieve a list of all contacts for the authenticated alias. This endpoint supports pagination and returns contacts in CardDAV format.

get/v1/contacts

Request

Base URL: https://api.forwardemail.net
URL: https://api.forwardemail.net/v1/contacts
Auth: HTTP basic

Query parameters

pageinteger

Page of results to return. If not specified, value will be 1. Must be a number greater than or equal to 1.

limitinteger

Number of results to return per page. Defaults to 25 if not specified. Must be a number greater than or equal to 1, and less than or equal to 100.

Response

Contacts retrieved successfully

idstring required

Contact ID (contact_id from CardDAV)

uidstring required

Contact UID

full_namestring required

Contact's full name

contentstring required

vCard content

etagstring required

ETag for versioning

is_groupboolean required

Whether contact is a group

created_atstring date-time required

updated_atstring date-time required

object'contact' required

Example response

[
  {
    "id": "contact123",
    "uid": "uid123",
    "full_name": "John Doe",
    "content": "BEGIN:VCARD\\nVERSION:3.0\\nUID:uid123\\nFN:John Doe\\nEMAIL;TYPE=INTERNET:john@example.com\\nEND:VCARD",
    "etag": "etag123",
    "is_group": false,
    "emails": [
      {
        "value": "john@example.com",
        "type": "INTERNET"
      }
    ],
    "phone_numbers": [
      {
        "value": "+1234567890",
        "type": "CELL"
      }
    ],
    "created_at": "2025-01-01T00:00:00.000Z",
    "updated_at": "2025-01-01T00:00:00.000Z",
    "object": "contact"
  }
]

Changes

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