GET /customers/:id

Returns the information Invisible Collector knows regarding a specific customer with a specific id.

The provided id can be either:

curl -XGET \
  --header "Content-Type: application/json" \
  --header "Authorization: Bearer 4a415cc660e67d8f4d26d5a7f390183a86fc3a4524ded78dc2448e86c48b2739" \
  https://api.invisiblecollector.com/customers/2314234
require "net/https"
require "uri"

uri = URI.parse("https://api.invisiblecollector.com/customers/2314234")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Get.new(uri.request_uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer 4a415cc660e67d8f4d26d5a7f390183a86fc3a4524ded78dc2448e86c48b2739'

response = http.request(request)
import com.ic.invisiblecollector.IcApiFacade;
import com.ic.invisiblecollector.model.Customer;

IcApiFacade apiFacade = new IcApiFacade("56a73507b66cd761caae7547ef2a66fc3a393746ba4bb9a91e303fcb3ceefb98");

String customerId = "1";
Customer upToDateCustomer = apiFacade.getCustomerFacade().requestCustomerInfo(customerId);

//or
Customer customer = ... //must containd an id or externalId
Customer upToDateCustomer = apiFacade.getCustomerFacade().requestCustomerInfo(customer);
using InvisibleCollectorLib;
using InvisibleCollectorLib.Model;

var ic = new InvisibleCollector("56a73507b66cd761caae7547ef2a66fc3a393746ba4bb9a91e303fcb3ceefb98");
string customerId = ... ;
Customer customer = await ic.GetCustomerInfoAsync(customerId);
iC, err := ic.NewInvisibleCollector("56a73507b66cd761caae7547ef2a66fc3a393746ba4bb9a91e303fcb3ceefb98", ic.InvisibleCollectorUri)

customerId := aCustomerModel.Id()
// or
customerId := aCustomerModel.RoutableId()

var channel = make(chan ic.CustomerPair)
go iC.GetCustomer(channel, customerId)
p := <-channel

fmt.Println(p.Customer)

This request will return, for example, the following JSON response:

{
  "name": "John Doe Inc.",
  "vatNumber": "PT543219876",
  "address": "Invisible Avenue, 456",
  "zipCode": "1234-543",
  "city": "Lisbon",
  "country": "PT",
  "email": "[email protected]",
  "phone": "555-555-555",
  "mobile": "444-444-444",
  "externalId": "345",
  "gid": "061d2feb-81c2-4694-a74a-13cecbe7d2ce",
  "locale": "pt"
}

Endpoint

GET https://api.invisiblecollector.com/customers/:id

Response body

Attribute Type Description
name string The name of this customer.
externalId string An external identification of this customer. Mainly used to facilitate integration with external systems.
vatNumber string The customer’s unique identification number for tax purposes.
address string The customer’s address.
zipCode string The customer’s zip code.
city string The customer’s city.
country string The customer’s ISO 3166-1 country code.
email string The customer’s email address. Will be used as the destination for email notifications.
phone string The customer’s phone number
mobile string The customer’s mobile number
gid string An unique identifier of this customer which can be used to retrive it.
locale string The customer’s locale. Will be used to set the language of notifications sent to the customer.

Errors

This endpoint may return the following errors

HTTP Code Description
401 Unauthorized Invalid credentials were supplied
404 Not found The user doesn’t have any customer registered with that specific id.

Feedback

If you have a question that needs an answer, please contact support.