Get Customer
GET /v1/nextrestaurant/customers/{customerId}
One customer
Needs customers:read.
Request
GET https://your-site.example/api/index.php/v1/nextrestaurant/customers/{customerId}Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
customerId |
integer |
path |
Yes | (min 1) |
Responses
200 — The customer.
{
"data": {
"id": 1,
"code": "string",
"first_name": "string",
"last_name": "string",
"email": "string",
"phone": "string",
"marketing_opt_in": true,
"default_location_id": 1,
"tags": [
"string"
],
"active": true,
"created_at": "string",
"updated_at": "string"
}
}| Field | Type | Meaning |
|---|---|---|
data.id |
integer |
|
data.code |
string|null |
|
data.first_name |
string|null |
|
data.last_name |
string|null |
|
data.email |
string|null |
|
data.phone |
string|null |
|
data.marketing_opt_in |
boolean |
|
data.default_location_id |
integer|null |
|
data.tags[] |
string[] |
|
data.active |
boolean |
|
data.created_at |
string|null |
|
data.updated_at |
string|null |
Errors
| Status | Code | When |
|---|---|---|
401 |
INVALID_TOKEN |
The token is missing, wrong, or none has been generated. |
403 |
INSUFFICIENT_SCOPE |
This API key does not have the permission this request needs. |
403 |
MODULE_DISABLED |
This module is disabled. |
403 |
API_DISABLED |
API is disabled |
404 |
NOT_FOUND |
No such record. |
429 |
RATE_LIMITED |
Too many requests. RATE_LIMITED with a Retry-After header: this key used its budget for the minute, or this address sent 20 bad tokens in 5 minutes. Nothing ran, so the request is safe to retry after the wait. |
Examples
curl
curl -s "https://your-site.example/api/index.php/v1/nextrestaurant/customers/1" \
-H "Authorization: Bearer $API_TOKEN"PHP
<?php
$ch = curl_init('https://your-site.example/api/index.php/v1/nextrestaurant/customers/1');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('API_TOKEN'),
],
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);JavaScript
const API_TOKEN = process.env.API_TOKEN;
const response = await fetch("https://your-site.example/api/index.php/v1/nextrestaurant/customers/1", {
headers: {
"Authorization": `Bearer ${API_TOKEN}`,
},
});
const data = await response.json();