Get Contact

Retrieves a single contact by id.

Authorization

AuthorizationRequiredBearer <token>

API key as Bearer token

In: header

Path Parameters

idRequiredstring

Contact id, discoverable via list_contacts

GET/v1/contacts/{id}

curl -X GET "https://api.3common.com/v1/contacts/string" \
  -H "Authorization: Bearer <token>"

Default Response

Response

{
  "data": {
    "id": "string",
    "firstName": "string",
    "lastName": "string",
    "fullName": "string",
    "email": "string",
    "phone": "string",
    "vendorId": "string",
    "orderSum": 0,
    "grossSum": 0,
    "firstOrder": 0,
    "lastOrder": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "status": "unsubscribed",
    "eventsAttended_IDS": [
      "string"
    ],
    "itemsPurchased_IDS": [
      "string"
    ],
    "productsPurchased_IDS": [
      "string"
    ],
    "property1": null,
    "property2": null
  }
}

TypeScript

export interface Response {
  data: {
    id: string;
    firstName: string;
    lastName: string;
    fullName: string;
    email: string;
    phone?: string;
    vendorId: string;
    orderSum: number;
    grossSum: number;
    /**
     * First order, ms since epoch
     */
    firstOrder?: number;
    /**
     * Most recent order, ms since epoch
     */
    lastOrder?: number;
    createdAt?: string;
    /**
     * Subset of statuses surfaced on the compact contact projection.
     */
    status: "unsubscribed" | "opted-in" | "unknown";
    eventsAttended_IDS: string[];
    itemsPurchased_IDS: string[];
    productsPurchased_IDS: string[];
    [k: string]: unknown;
  };
}