Retrieves the customer details.

curl --request GET \
  --url https://api.example.com/api/customers/{id} \
  --header 'Authorization: <authorization>' \
  --header 'organization-id: <organization-id>'

import requests

url = "https://api.example.com/api/customers/{id}"

headers = {
    "Authorization": "<authorization>",
    "organization-id": "<organization-id>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {Authorization: '<authorization>', 'organization-id': '<organization-id>'}
};

fetch('https://api.example.com/api/customers/{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://api.example.com/api/customers/{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: <authorization>",
    "organization-id: <organization-id>"
  ],
]);

$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://api.example.com/api/customers/{id}"

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

	req.Header.Add("Authorization", "<authorization>")
	req.Header.Add("organization-id", "<organization-id>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.example.com/api/customers/{id}")
  .header("Authorization", "<authorization>")
  .header("organization-id", "<organization-id>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/customers/{id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'
request["organization-id"] = '<organization-id>'

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

{
  "balance": 1500,
  "currencyCode": "USD",
  "openingBalance": 1000,
  "openingBalanceAt": "2024-01-01T00:00:00Z",
  "openingBalanceExchangeRate": 1,
  "displayName": "John Doe - Acme Corporation",
  "note": "Important client with regular monthly orders",
  "active": true,
  "createdAt": "2024-01-01T00:00:00Z",
  "updatedAt": "2024-01-01T00:00:00Z",
  "localOpeningBalance": 1000,
  "closingBalance": 1500,
  "openingBalanceBranchId": 1,
  "salutation": "Mr.",
  "firstName": "John",
  "lastName": "Doe",
  "companyName": "Acme Corporation",
  "email": "[email protected]",
  "workPhone": "+1 (555) 123-4567",
  "personalPhone": "+1 (555) 987-6543",
  "website": "https://www.acme.com",
  "billingAddress1": "123 Business Ave",
  "billingAddress2": "Suite 100",
  "billingAddressCity": "New York",
  "billingAddressCountry": "United States",
  "billingAddressEmail": "[email protected]",
  "billingAddressPostcode": "10001",
  "billingAddressPhone": "+1 (555) 111-2222",
  "billingAddressState": "NY",
  "shippingAddress1": "456 Shipping St",
  "shippingAddress2": "Unit 200",
  "shippingAddressCity": "Los Angeles",
  "shippingAddressCountry": "United States",
  "shippingAddressEmail": "[email protected]",
  "shippingAddressPostcode": "90001",
  "shippingAddressPhone": "+1 (555) 333-4444",
  "shippingAddressState": "CA"
}

GET

api

customers

{id}

Retrieves the customer details.

curl --request GET \
  --url https://api.example.com/api/customers/{id} \
  --header 'Authorization: <authorization>' \
  --header 'organization-id: <organization-id>'

import requests

url = "https://api.example.com/api/customers/{id}"

headers = {
    "Authorization": "<authorization>",
    "organization-id": "<organization-id>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {Authorization: '<authorization>', 'organization-id': '<organization-id>'}
};

fetch('https://api.example.com/api/customers/{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://api.example.com/api/customers/{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: <authorization>",
    "organization-id: <organization-id>"
  ],
]);

$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://api.example.com/api/customers/{id}"

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

	req.Header.Add("Authorization", "<authorization>")
	req.Header.Add("organization-id", "<organization-id>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.example.com/api/customers/{id}")
  .header("Authorization", "<authorization>")
  .header("organization-id", "<organization-id>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/customers/{id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'
request["organization-id"] = '<organization-id>'

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

{
  "balance": 1500,
  "currencyCode": "USD",
  "openingBalance": 1000,
  "openingBalanceAt": "2024-01-01T00:00:00Z",
  "openingBalanceExchangeRate": 1,
  "displayName": "John Doe - Acme Corporation",
  "note": "Important client with regular monthly orders",
  "active": true,
  "createdAt": "2024-01-01T00:00:00Z",
  "updatedAt": "2024-01-01T00:00:00Z",
  "localOpeningBalance": 1000,
  "closingBalance": 1500,
  "openingBalanceBranchId": 1,
  "salutation": "Mr.",
  "firstName": "John",
  "lastName": "Doe",
  "companyName": "Acme Corporation",
  "email": "[email protected]",
  "workPhone": "+1 (555) 123-4567",
  "personalPhone": "+1 (555) 987-6543",
  "website": "https://www.acme.com",
  "billingAddress1": "123 Business Ave",
  "billingAddress2": "Suite 100",
  "billingAddressCity": "New York",
  "billingAddressCountry": "United States",
  "billingAddressEmail": "[email protected]",
  "billingAddressPostcode": "10001",
  "billingAddressPhone": "+1 (555) 111-2222",
  "billingAddressState": "NY",
  "shippingAddress1": "456 Shipping St",
  "shippingAddress2": "Unit 200",
  "shippingAddressCity": "Los Angeles",
  "shippingAddressCountry": "United States",
  "shippingAddressEmail": "[email protected]",
  "shippingAddressPostcode": "90001",
  "shippingAddressPhone": "+1 (555) 333-4444",
  "shippingAddressState": "CA"
}

Headers

Authorization

string

required

Value must be 'Bearer ' where is an API key prefixed with 'bc_' or a JWT token.

Example:

"Bearer bc_1234567890abcdef"

organization-id

string

required

Required if Authorization is a JWT token. The organization ID to operate within.

Path Parameters

number

required

Response

200 - application/json

The customer details have been successfully retrieved.

balance

number

required

Example:

1500

currencyCode

string

required

Example:

"USD"

openingBalance

number

required

Example:

1000

openingBalanceAt

string<date-time>

required

Example:

"2024-01-01T00:00:00Z"

openingBalanceExchangeRate

number

required

Example:

1

displayName

string

required

Example:

"John Doe - Acme Corporation"

note

string

required

Example:

"Important client with regular monthly orders"

active

boolean

required

Example:

true

createdAt

string<date-time>

required

Example:

"2024-01-01T00:00:00Z"

updatedAt

string<date-time>

required

Example:

"2024-01-01T00:00:00Z"

localOpeningBalance

number

required

Example:

1000

closingBalance

number

required

Example:

1500

openingBalanceBranchId

number

Example:

1

salutation

string

Example:

"Mr."

firstName

string

Example:

"John"

lastName

string

Example:

"Doe"

companyName

string

Example:

"Acme Corporation"

string

Example:

"[email protected]"

workPhone

string

Example:

"+1 (555) 123-4567"

personalPhone

string

Example:

"+1 (555) 987-6543"

website

string

Example:

"https://www.acme.com"

billingAddress1

string

Example:

"123 Business Ave"

billingAddress2

string

Example:

"Suite 100"

billingAddressCity

string

Example:

"New York"

billingAddressCountry

string

Example:

"United States"

billingAddressEmail

string

Example:

"[email protected]"

billingAddressPostcode

string

Example:

"10001"

billingAddressPhone

string

Example:

"+1 (555) 111-2222"

billingAddressState

string

Example:

"NY"

shippingAddress1

string

Example:

"456 Shipping St"

shippingAddress2

string

Example:

"Unit 200"

shippingAddressCity

string

Example:

"Los Angeles"

shippingAddressCountry

string

Example:

"United States"

shippingAddressEmail

string

Example:

"[email protected]"

shippingAddressPostcode

string

Example:

"90001"

shippingAddressPhone

string

Example:

"+1 (555) 333-4444"

shippingAddressState

string

Example:

"CA"

Mark the given warehouse transfer as transferred.Edit the given customer.

Get Started

API Reference

Retrieves the customer details.

Headers

Path Parameters

Response