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.
| Method | URL | API key permission | Package |
|---|---|---|---|
| GET | https://rental.software/api6/customers/{customer_id} | Customers: Read Only or Full Access | WP/API |
Prerequisites
- An active API key created under Settings > API Keys. See API - Setup Access.
- The API key must have Customers access (Read Only is enough) in its permissions.
- The API & WordPress module must be active on your account: Settings > Subscription.
- If the API key is limited to certain locations, it can only retrieve customers in those locations.
Step-by-Step Instructions
- Get or generate an API key via Settings > API Keys.
- Confirm the key has Customers access in the permissions section.
- Build a GET request using the customer ID in the path and your API key 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=YOUR_API_KEY" -H "Accept: application/json"
- Inspect the returned JSON object for customer fields, tags and custom fields.
Parameters
| Parameter | Where | Required | Description |
|---|---|---|---|
| customer_id | URL path | Yes | Numeric ID of the customer, placed in the URL: /api6/customers/{customer_id} |
| apiKey | Query string | Yes | Your API key, for example ?apiKey=YOUR_API_KEY |
The _body=true parameter used on list calls is not needed here. A single customer is always returned in full.
Response Example
{
"id": "533261",
"createtime": "2024-09-30T11:07:51-04:00",
"modifiedtime": "2025-07-16T12:50:08-04:00",
"organization": "Big Company",
"firstname": "Jordan",
"lastname": "Rivera",
"street": "123 Main St",
"city": "Akron",
"state": "OH",
"zip": "44301",
"country": "",
"homephone": "(330) 555-0142",
"officephone": "(330) 555-0143",
"cellphone": "(330) 555-0144",
"fax": "",
"email": "jordan.rivera@example.com",
"notes": "",
"customertype": "Commercial",
"locationid": "0",
"tags": [
"repeat customer",
"school"
],
"customfields_ids": {
"35854": {
"name": "Gate Code",
"value": "1234",
"type": "smalltext",
"options": null
}
},
"href": "https://rental.software/api6/customers/533261",
"createtime_ts": "1727708871",
"createtime_utc": "2024-09-30T15:07:51Z",
"modifiedtime_ts": "1752684608",
"modifiedtime_utc": "2025-07-16T16:50:08Z",
"request_time": 1760000000
}Returned Fields
| Field | Description |
|---|---|
| id | Customer ID |
| firstname, lastname, organization | Name and company |
| street, city, state, zip, country | Address |
| homephone, officephone, cellphone, fax, email | Contact details |
| notes, customertype, locationid | Customer notes, customer type, and the location the customer belongs to (0 on single location accounts) |
| tags | Array of tag strings |
| customfields_ids | Object keyed by custom field ID. Each value contains name, value, type and options |
| href | URL of this customer in the API |
| createtime, modifiedtime | Date and time in your account's time zone. Each also comes as a Unix timestamp (_ts) and as UTC (_utc) |
| request_time | Unix timestamp of when the API answered |
The response can include a few extra keys not listed here. Your code should ignore keys it does not use.
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
| What you see | What it means | What to do |
|---|---|---|
| 401 "No API Key provided" | The request has no apiKey | Add ?apiKey=YOUR_API_KEY to the URL |
| 401 "API key not found" | The key is mistyped or was removed | Copy the key again from Settings > API Keys |
| 403 "Permission access restricted" | The key has no Customers access | Open the key under Settings > API Keys and set Customers to Read Only or Full Access |
| 403 "Location access restricted" | The customer belongs to a location the key cannot access | Give the key access to that location |
| 404 "Customer not found" | No customer with that ID exists in your account | Confirm the customer ID |
| 429 "Too Many Requests" | You exceeded a rate limit | Wait, then retry less often. See API - Errors and Rate Limits |
Where are my custom fields? Custom fields are returned in customfields_ids, keyed by field ID. Example: customfields_ids["35854"].value.
I need to update tags or replace all tags. When creating or updating customers, use custtags and cleartags=1 to replace existing tags. See API - Customers - Create or Update.