APIv3
Exit Documentation

Getting started

Create an API key, authenticate a request, and retrieve customers from your SalesBinder account.

Create an API key

  1. Sign in to SalesBinder.
  2. Open your profile.
  3. Select API Keys.
  4. Enter a descriptive key name.
  5. Choose whether the key should inherit all actions allowed by your permissions or use restricted scopes.
  6. Create the key and copy it immediately.

The complete API key is displayed only once. SalesBinder stores a secure hash and cannot show the complete key again.

Make your first request

Pass the API key in the Authorization header using the Bearer authentication scheme:

bash
curl "https://yourbusiness.salesbinder.com/api/v3/customers?limit=5" \
  --header "Accept: application/json" \
  --header "Authorization: Bearer YOUR_API_KEY"

A successful request returns a list object:

json
{
  "object": "list",
  "url": "/api/v3/customers",
  "has_more": true,
  "data": [
    {
      "id": "709d2a43-12a9-4d85-a9d9-cb16e66cef53",
      "object": "customer",
      "customer_number": 527,
      "name": "Example Customer"
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 5,
    "total_pages": 4,
    "total_records": 20
  }
}

Examples in this documentation may omit unchanged fields for readability. Resource reference pages show the complete response object.

Send JSON data

For POST, PUT, and PATCH requests, send a JSON object and set Content-Type: application/json:

bash
curl "https://yourbusiness.salesbinder.com/api/v3/customers" \
  --request POST \
  --header "Accept: application/json" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{"name":"Example Customer"}'

Next steps