API - Customers - Retrieve Details | API

Retrieve a single customer's full record by passing the Customer ID to the Customers API endpoint. The call returns a JSON object with contact info, tags, custom fields and timestamps.

Prerequisites

An active API token (apiKey) created under Settings → API Keys: https://rental.software/account/#/settings/api
API token must have access to Customers (read) in its permissions.
The WordPress/API add-on must be enabled on your account if required by your plan: https://rental.software/account/#/settings/subscription
Respect the rate limit: 300 calls per 300 seconds (exceeding this returns HTTP 429).

Step-by-step instructions

Get or generate an API token via Settings → API Keys.
Confirm the token has Customer access (read) in the permissions section.
Build a GET request using the customer ID in the path and your apiKey as a query parameter:
```
GET https://rental.software/api6/customers/{customer_id}?apiKey=YOUR_API_KEY
	
```

Send the request (example using curl):

curl "https://rental.software/api6/customers/533261?apiKey=XXXXXX" -H "Accept: application/json"

Inspect the returned JSON object for customer fields, tags and customfields_ids.

Request example

GET /api6/customers/533261?apiKey=XXXXXX

Response example

{
  "id": "533261",
  "createtime": "2014-09-30T11:07:51-04:00",
  "modifiedtime": "2015-07-16T12:50:08-04:00",
  "organization": "Big Company",
  "firstname": "Joel",
  "lastname": "Smith",
  "street": "123 Tst st",
  "city": "Clelaveld",
  "state": "OH",
  "zip": "44444",
  "country": "",
  "homephone": "(234) 654-0257",
  "officephone": "(234) 654-0257",
  "cellphone": "(234) 654-0257",
  "fax": "",
  "email": "joel.smith@example.com",
  "notes": "",
  "customertype": "Commercial",
  "locationid": "0",
  "tags": [
    "cool",
    "annoying"
  ],
  "customfields_ids": {
    "35854": {
      "name": "test field",
      "value": "test response",
      "type": "smalltext",
      "options": null
    }
  },
  "href": "https://rental.software/api6/customers/533261",
  "createtime_ts": "1412089671",
  "createtime_utc": "2014-09-30T15:07:51Z",
  "modifiedtime_ts": "1437065408",
  "modifiedtime_utc": "2015-07-16T16:50:08Z"
}

Feature Options & Parameters

Path parameter — customer_id (required): numeric ID placed in the URL /api6/customers/{customer_id}
Query parameter — apiKey (required): your API token, e.g. ?apiKey=XXXXXX
Returned fields — common keys:
- id, firstname, lastname, organization, street, city, state, zip, country
- homephone, officephone, cellphone, fax, email, notes, customertype, locationid
- tags — array of tag strings
- customfields_ids — object keyed by custom field id; value contains name, value, type, options
- href — URL to the customer endpoint; createtime_ts / createtime_utc and modifiedtime_ts / modifiedtime_utc
For paged list endpoints (GET /api6/customers) you can use _body=true
to request more detailed items (not required for single-customer retrieve).

Use Cases

Prefill customer contact and billing details on a booking or quote form on your website.
Sync customer records into an external CRM or reporting tool for support or marketing.

Troubleshooting & FAQs

Empty or no response — Verify you included ?apiKey=YOUR_KEY
and the key is valid.
Permission denied / unauthorized — Check the API key permissions in Settings → API Keys and ensure Customers (read) access is granted. See API Setup: https://rental.software/account/#/settings/api
Customer not found — Confirm the customer ID is correct and belongs to the same account/environment that the API key is associated with.
Missing custom fields — Custom fields are returned in customfields_ids
keyed by field ID. Example:
customfields_ids["35854"].value
.
429 Too Many Requests — You exceeded the rate limit (300 calls / 300 seconds). Wait and retry or reduce request frequency.
I need to update tags or replace all tags — When creating/updating customers, use custtags
and
cleartags=1
to replace existing tags (see API - Customers create/update docs).

API - Customers - Retrieve Details