List shop contacts
Returns a paginated list of contacts (customers) for a shop. Requires admin scope.
GET
/shops/{shop_id}/contactsAuthorization
AuthorizationBearer token (JWT) · headerrequiredOAuth 2.0 Bearer token. Obtain via `POST https://auth.onbolder.com/oauth/token`.
Scopes:
adminPath parameters
shop_idstringrequiredShop ID or subdomain
Query parameters
pageintegerPage number
default: 1
per_pageintegerItems per page
default: 50
qstringFull-text search (name, email)
created_on_gtestring<date>created_on_ltestring<date>updated_on_gtestring<date>updated_on_ltestring<date>sortstringResponses
200Paginated contacts list
total_itemsintegerpageintegerper_pageinteger_linksobjectShow propertiesHide properties
selfHalLinkShow propertiesHide properties
hrefstringmethodstringtitlestringtypestringtemplatedbooleannextHalLinkShow propertiesHide properties
hrefstringmethodstringtitlestringtypestringtemplatedbooleanlastHalLinkShow propertiesHide properties
hrefstringmethodstringtitlestringtypestringtemplatedboolean_embeddedobjectShow propertiesHide properties
itemsContactFull[]Show propertiesHide properties
Array of
ContactFullidintegernamestringemailstringphone_numberstringcompanystringopt_inbooleanavailable_orders_countintegercreated_onstring<date-time>updated_onstring<date-time>Request
curl -X GET "https://api.onbolder.com/v1/shops/string/contacts" \
-H "Authorization: Bearer YOUR_TOKEN"const response = await fetch("https://api.onbolder.com/v1/shops/string/contacts", {
method: "GET",
headers: {
"Authorization": "Bearer YOUR_TOKEN"
}
});import requests
response = requests.get(
"https://api.onbolder.com/v1/shops/string/contacts",
headers={
"Authorization": "Bearer YOUR_TOKEN"
},
)Response
{
"total_items": 0,
"page": 0,
"per_page": 0,
"_links": {
"self": {
"href": "string",
"method": "string",
"title": "string",
"type": "string",
"templated": true
},
"next": {
"href": "string",
"method": "string",
"title": "string",
"type": "string",
"templated": true
},
"last": {
"href": "string",
"method": "string",
"title": "string",
"type": "string",
"templated": true
}
},
"_embedded": {
"items": [
{
"id": 0,
"name": "string",
"email": "string",
"phone_number": "string",
"company": "string",
"opt_in": true,
"available_orders_count": 0,
"created_on": "2019-08-24T14:15:22Z",
"updated_on": "2019-08-24T14:15:22Z"
}
]
}
}