Get a Customer's Information

This API endpoint allows you to retrieve the details of a customer record for a specified subcompany. You need to provide the subcompany ID and the customer's unique ID in the URL path. The takeover secret must be included in the header.

Get Customer

GEThttps://v3-api.proto.cx/api/platform/v1/customers/{subcompany_id}/customer/{provided_unique_id}/get-customer

Path parameters

subcompany_id*Subcompany Id

provided_unique_id*Provided Unique Id

Header parameters

Response

200404422

Successful Response

Body

application/json

id*Id

external_customer_id*External Customer Id

stringnull

provided_unique_id*Provided Unique Id

stringnull

name*Name

stringnull

location*Location

stringnull

email*Email

string (email)null

phone_number*Phone Number

stringnull

avatar*Avatar

stringnull

notes*Notes

tags*Tags

tag_groups*Tag Groups

gateway_profiles*Gateway Profiles

Request

JavaScriptCurlPython

const response = await fetch('https://v3-api.proto.cx/api/platform/v1/customers/{subcompany_id}/customer/{provided_unique_id}/get-customer', {
    method: 'GET',
    headers: {
      "authorization": "text"
    },
});
const data = await response.json();

Response

200422

{
  "id": "text",
  "external_customer_id": "text",
  "provided_unique_id": "text",
  "name": "text",
  "location": "text",
  "email": "[e-mail]",
  "phone_number": "text",
  "avatar": "text",
  "notes": [
    {
      "id": "text",
      "created_at": "2024-09-16T20:13:52.054Z",
      "updated_at": "2024-09-16T20:13:52.054Z",
      "text": "text",
      "color": "text",
      "created_by_id": "text"
    }
  ],
  "tags": [
    {
      "id": "text",
      "tag": "text",
      "color": "text"
    }
  ],
  "tag_groups": [
    {
      "id": "text",
      "name": "text",
      "color": "text",
      "tags": [
        {
          "id": "text",
          "tag": "text",
          "color": "text"
        }
      ]
    }
  ],
  "gateway_profiles": [
    {
      "id": "text",
      "gateway_type": "proto_v2",
      "gateway_user_id": "text",
      "name": "text",
      "location": "text",
      "email": "text",
      "phone_number": "text",
      "avatar": "text",
      "ip_address": "0.0.0.0",
      "browser": "text",
      "os": "text"
    }
  ]
}