API Documentation

AccountsView Account

Method: /customers/[id].[format]

Contexts:

SalesBinder Accounts have 3 different “context” values to determine what type of account you want to create:

Customers Context ID: 2, Prospects Context ID: 8, Suppliers Context ID: 10

Note:
– although the method used is named “/customers/[id].[format]”, this works for any of the 3 context types
– all three contexts share the same fields and data types outlined below

Permissions Required:

View Customers and/or Prospects and/or Suppliers

Syntax:

https://[subdomain].salesbinder.com/api/2.0/customers/[id].json

HTTP Request Type: GET

Sample Returned JSON Data

1{
2    "customer": {
3        "name": "Widgets Emporium",
4        "customer_number": 516,
5        "office_email": "widgets@testing.com",
6        "office_phone": "604-968-9588",
7        "office_fax": "",
8        "url": "www.widgets.com",
9        "billing_address_1": "4567 Testing Avenue",
10        "billing_address_2": "",
11        "billing_city": "Montreal",
12        "billing_region": "British Columbia",
13        "billing_postal_code": "M5H 2G5",
14        "billing_country": "",
15        "shipping_address_1": "4567 Testing Avenue",
16        "shipping_address_2": "",
17        "shipping_city": "Montreal",
18        "shipping_region": "British Columbia",
19        "shipping_postal_code": "M5H 2G5",
20        "shipping_country": "",
21        "id": "549490bc-e910-41a4-b83f-03d8a2d10228",
22        "created": "2014-12-19T20:55:24+00:00",
23        "modified": "2016-11-11T00:13:12+00:00"
24    }
25}

Sample Returned XML Data

1<?xml version="1.0" encoding="UTF-8" ?>
2<response>
3    <customer>
4        <name>Widgets Emporium</name>
5        <customer_number>516</customer_number>
6        <office_email>widgets@testing.com</office_email>
7        <office_phone>604-968-9588</office_phone>
8        <office_fax/>
9        <url>www.widgets.com</url>
10        <billing_address_1>4567 Testing Avenue</billing_address_1>
11        <billing_address_2/>
12        <billing_city>Montreal</billing_city>
13        <billing_region>British Columbia</billing_region>
14        <billing_postal_code>M5H 2G5</billing_postal_code>
15        <billing_country/>
16        <shipping_address_1>4567 Testing Avenue</shipping_address_1>
17        <shipping_address_2/>
18        <shipping_city>Montreal</shipping_city>
19        <shipping_region>British Columbia</shipping_region>
20        <shipping_postal_code>M5H 2G5</shipping_postal_code>
21        <shipping_country/>
22        <id>549490bc-e910-41a4-b83f-03d8a2d10228</id>
23        <created>12/19/14, 8:55 PM</created>
24        <modified>11/11/16, 12:13 AM</modified>
25    </customer>
26</response>

Updated on February 7th, 2022