Get Customer

GET

customer

{customer_id}

Get Customer

curl --request GET \
  --url https://zeus-api.atlas.so/v1/customer/{customer_id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://zeus-api.atlas.so/v1/customer/{customer_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://zeus-api.atlas.so/v1/customer/{customer_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://zeus-api.atlas.so/v1/customer/{customer_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://zeus-api.atlas.so/v1/customer/{customer_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "email": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "isVisitor": false,
  "userId": "<string>",
  "location": "<string>",
  "ip": "<string>",
  "customFields": {},
  "phoneNumber": "<string>",
  "fields": {},
  "account": {
    "id": "<string>",
    "name": "<string>",
    "email": "<string>",
    "website": "<string>",
    "customFields": {}
  },
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "visitorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

customer_id

string<uuid>

required

Response

Customer · object | null

Successful Response

string | null

firstName

string | null

lastName

string | null

isVisitor

boolean | null

default:false

If is a visitor, this is set to true in the response

userId

string | null

Identifier for the customer in your system

location

string | null

customFields

Customfields · object | null

phoneNumber

string | null

fields

Fields · object | null

account

ChatbotAccount · object | null

Show child attributes

string<uuid> | null

visitorId

string<uuid> | null

If the customer was a visitor previously, set this to the visitor's id to link the visitor to this customer

Get Customer

curl --request GET \
  --url https://zeus-api.atlas.so/v1/customer/{customer_id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://zeus-api.atlas.so/v1/customer/{customer_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://zeus-api.atlas.so/v1/customer/{customer_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://zeus-api.atlas.so/v1/customer/{customer_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://zeus-api.atlas.so/v1/customer/{customer_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "email": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "isVisitor": false,
  "userId": "<string>",
  "location": "<string>",
  "ip": "<string>",
  "customFields": {},
  "phoneNumber": "<string>",
  "fields": {},
  "account": {
    "id": "<string>",
    "name": "<string>",
    "email": "<string>",
    "website": "<string>",
    "customFields": {}
  },
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "visitorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Overview

Guides

API Reference

Authorizations

Path Parameters

Response