v1

latestOpenAPI 3.0.22026-07-24800528.1 KB

Customers

Retrieve a customer

Gets a customer with a given customer key.

get/v2/customers/{customer_key}

Path parameters

customer_keystring required

Unique identifier for customers. This is the same as the customer_key that can be assigned using PartnerStackJS.

Response

Gets a customer with a given customer key.

messagestring required

statusinteger required

Example response

{
  "data": {
    "created_at": 1574181282399,
    "key": "co_a80cb515fe",
    "updated_at": 1574181282399,
    "customer_key": "123435",
    "email": "johnsmith@gmail.com",
    "fields": [
      {
        "field_key": "field_fjkdlrh9i32nfew",
        "name": "Company Address"
      }
    ],
    "mdata": {
      "api_key": "value"
    },
    "meta": {
      "field": "value"
    },
    "name": "John Smith",
    "partner_key": "bertramgilfoyle",
    "partnership_key": "part_A7nGc9pKnx8xEW",
    "provider_key": "cus_AJ6bvXbVofMpsW",
    "shared_id": "fake_shared_id",
    "source_key": "deal_987us345r2",
    "source_type": "deal",
    "submitted_by": "johndoe@gmail.com",
    "submitted_by_email": "johndoe@gmail.com",
    "team": {
      "color": "blue",
      "logo": "file12345.png",
      "name": "Team Whippets"
    },
    "test": true
  }
}