Contacts

Get a contact

Changed on Nov 5, 2026

Retrieve a single contact by its unique id.

Required scope: contacts_read

get/contacts/{id}

Request

Base URL
https://api.privy.com/v1
Auth
HTTP bearer

Path parameters

idstring required

The contact's unique identifier (returned as id in contact responses). Ids are opaque cus_-prefixed strings — a numeric id from a Privy dashboard URL is not a valid API id and will 404; list contacts, or look the contact up by ?email= or ?phone_number=, instead.

Headers

Privy-Account-Idstring

Target a subaccount instead of the main connected account. Pass a subaccount id from get_account's subaccounts list. Only direct subaccounts of the connected account are reachable — omit this for the main account itself.

Response

The requested contact.

Example response

{
  "data": {
    "id": "cus_a1b2c3d4e5f6g7h8",
    "first_name": "Jane",
    "last_name": "Doe",
    "email": "jane@example.com",
    "email_consent": "subscribed",
    "email_consent_at": "2025-03-20T14:22:00Z",
    "phone_number": "+15551234567",
    "sms_consent": "subscribed",
    "sms_consent_at": "2025-03-20T14:22:00Z",
    "source": "csv",
    "source_type": "import",
    "imported": true,
    "import_ids": [
      "im_k2R5m8Q"
    ],
    "tags": [
      "vip",
      "repeat-buyer"
    ],
    "custom_fields": {
      "loyalty_tier": "gold",
      "referral_code": "JANE2024"
    },
    "created_at": "2025-01-15T10:30:00Z",
    "updated_at": "2025-03-20T14:22:00Z",
    "signups": [
      {
        "display_id": "gk2P8Zw1Lq",
        "display_title": "Welcome Popup",
        "coupon_code": "VIP4F2A9C1B",
        "created_at": "2025-03-20T14:22:00Z"
      }
    ]
  }
}

Changes

Nov 5, 2026cf0885e90d5a Revision changes
- warning
  added the new forbidden enum value to the / response property for the response status
- warning
  added the new forbidden enum value to the / response property for the response status
- warning
  added the new forbidden enum value to the / response property for the response status
- warning
  added the new forbidden enum value to the / response property for the response status
- warning
  added the new segment_builder_required enum value to the / response property for the response status
- warning
  added the new segment_builder_required enum value to the / response property for the response status
- warning
  added the new segment_builder_required enum value to the / response property for the response status
- warning
  added the new segment_builder_required enum value to the / response property for the response status
Nov 3, 2026fe500ab59b3b Revision changes
- breaking
  the response's property type changed from object to no type for status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  added the new api_access_required enum value to the / response property for the response status
- warning
  added the new api_access_required enum value to the / response property for the response status
- warning
  added the new api_access_required enum value to the / response property for the response status
- warning
  added the new api_access_required enum value to the / response property for the response status
- warning
  added the new contacts_not_ready enum value to the / response property for the response status
- warning
  added the new contacts_not_ready enum value to the / response property for the response status
- warning
  added the new contacts_not_ready enum value to the / response property for the response status
- warning
  added the new contacts_not_ready enum value to the / response property for the response status
- warning
  added the new no_connected_store enum value to the / response property for the response status
- warning
  added the new no_connected_store enum value to the / response property for the response status
- warning
  added the new no_connected_store enum value to the / response property for the response status
- warning
  added the new no_connected_store enum value to the / response property for the response status
- warning
  added the new paid_plan_required enum value to the / response property for the response status
- warning
  added the new paid_plan_required enum value to the / response property for the response status
- warning
  added the new paid_plan_required enum value to the / response property for the response status
- warning
  added the new paid_plan_required enum value to the / response property for the response status
- warning
  added the new store_unavailable enum value to the / response property for the response status
- warning
  added the new store_unavailable enum value to the / response property for the response status
- warning
  added the new store_unavailable enum value to the / response property for the response status
- warning
  added the new store_unavailable enum value to the / response property for the response status
- info
  added the new optional header request parameter Privy-Account-Id
- info
  added subschema #2 to the response property allOf list for the response status

Operation history