Appearance
Customer Data
Get all Customers
GET /v1/customersHeaders
Accept: application/json
Authorization: Bearer {YOUR_ACCESS_TOKEN}Response 200
json
{
"data": [
{
"type": "customer",
"id": 43,
"attributes": {
"first_name": "Demo",
"last_name": "User",
"email": "demo.user@demo.com",
"telephone": "01234567890",
"address": "23-25 Fake Street",
"city": "Fakesford",
"postcode": "CM2 7HX",
"county": null,
"country": null,
"email_optin": 0,
"created_at": "2025-12-17T12:03:59.000000Z",
"updated_at": "2025-12-17T12:03:59.000000Z"
},
"relationships": {
"orders": {
"links": {
"related": "https://appx-api.mysticky.co.uk/api/v1/customers/43/orders"
}
}
},
"links": {
"self": "https://appx-api.mysticky.co.uk/api/v1/customers/43"
}
}
],
"links": {
"first": "https://appx-api.mysticky.co.uk/api/v1/customers?page=1",
"last": "https://appx-api.mysticky.co.uk/api/v1/customers?page=3",
"prev": null,
"next": "https://appx-api.mysticky.co.uk/api/v1/customers?page=2"
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 3,
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "https://appx-api.mysticky.co.uk/api/v1/customers?page=1",
"label": "1",
"active": true
},
{
"url": "https://appx-api.mysticky.co.uk/api/v1/customers?page=2",
"label": "2",
"active": false
},
{
"url": "https://appx-api.mysticky.co.uk/api/v1/customers?page=3",
"label": "3",
"active": false
},
{
"url": "https://appx-api.mysticky.co.uk/api/v1/customers?page=2",
"label": "Next »",
"active": false
}
],
"path": "https://appx-api.mysticky.co.uk/api/v1/customers",
"per_page": 15,
"to": 15,
"total": 36
}
}Get all Customers - Filter By Telephone
GET /v1/customers?telephone={number}Parameters
| Name | Type | Description | Example |
|---|---|---|---|
number | string | Telephone Number | 01234567890 |
Headers
Accept: application/json
Authorization: Bearer {YOUR_ACCESS_TOKEN}- Results are paginated.
- Max. 15 devices per page.
- Navigation meta is provided.
Filter [telephone]
A complete telephone number - exact match.
Example:
- /customers?telephone=01234567890
Response 200
json
{
"data": [
{
"type": "customer",
"id": 43,
"attributes": {
"first_name": "Demo",
"last_name": "User",
"email": "demo.user@demo.com",
"telephone": "01234567890",
"address": "23-25 Fake Street",
"city": "Fakesford",
"postcode": "CM2 7HX",
"county": null,
"country": null,
"email_optin": 0,
"created_at": "2025-12-17T12:03:59.000000Z",
"updated_at": "2025-12-17T12:03:59.000000Z"
},
"relationships": {
"orders": {
"links": {
"related": "https://appx-api.mysticky.co.uk/api/v1/customers/43/orders"
}
}
},
"links": {
"self": "https://appx-api.mysticky.co.uk/api/v1/customers/43"
}
}
],
"links": {
"first": "https://appx-api.mysticky.co.uk/api/v1/customers?page=1",
"last": "https://appx-api.mysticky.co.uk/api/v1/customers?page=2",
"prev": null,
"next": "https://appx-api.mysticky.co.uk/api/v1/customers?page=2"
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 2,
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "https://appx-api.mysticky.co.uk/api/v1/customers?page=1",
"label": "1",
"active": true
},
{
"url": "https://appx-api.mysticky.co.uk/api/v1/customers?page=2",
"label": "2",
"active": false
},
{
"url": "https://appx-api.mysticky.co.uk/api/v1/customers?page=2",
"label": "Next »",
"active": false
}
],
"path": "https://appx-api.mysticky.co.uk/api/v1/customers",
"per_page": 15,
"to": 15,
"total": 19
}
}Get all Customers - Filter By Email
GET /v1/customers?email={emailaddress}Parameters
| Name | Type | Description | Example |
|---|---|---|---|
emailaddress | string | Email Address | demo.user@demo.com |
Headers
Accept: application/json
Authorization: Bearer {YOUR_ACCESS_TOKEN}- Results are paginated.
- Max. 15 devices per page.
- Navigation meta is provided.
Filter [emailaddress]
A complete email address - exact match.
Example:
- /customers?email=demo.user@demo.com
Response 200
json
{
"data": [
{
"type": "customer",
"id": 43,
"attributes": {
"first_name": "Demo",
"last_name": "User",
"email": "demo.user@demo.com",
"telephone": "01234567890",
"address": "23-25 Fake Street",
"city": "Fakesford",
"postcode": "CM2 7HX",
"county": null,
"country": null,
"email_optin": 0,
"created_at": "2025-12-17T12:03:59.000000Z",
"updated_at": "2025-12-17T12:03:59.000000Z"
},
"relationships": {
"orders": {
"links": {
"related": "https://appx-api.mysticky.co.uk/api/v1/customers/43/orders"
}
}
},
"links": {
"self": "https://appx-api.mysticky.co.uk/api/v1/customers/43"
}
}
],
"links": {
"first": "https://appx-api.mysticky.co.uk/api/v1/customers?page=1",
"last": "https://appx-api.mysticky.co.uk/api/v1/customers?page=2",
"prev": null,
"next": "https://appx-api.mysticky.co.uk/api/v1/customers?page=2"
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 2,
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "https://appx-api.mysticky.co.uk/api/v1/customers?page=1",
"label": "1",
"active": true
},
{
"url": "https://appx-api.mysticky.co.uk/api/v1/customers?page=2",
"label": "2",
"active": false
},
{
"url": "https://appx-api.mysticky.co.uk/api/v1/customers?page=2",
"label": "Next »",
"active": false
}
],
"path": "https://appx-api.mysticky.co.uk/api/v1/customers",
"per_page": 15,
"to": 15,
"total": 19
}
}Get a Customer
GET /customers/{id}Parameters
| Name | Type | Description | Example |
|---|---|---|---|
id | int | Customer ID | 43 |
Headers
Accept: application/json
Authorization: Bearer {YOUR_ACCESS_TOKEN}This includes a link for customer orders.
Response 200
json
{
"data": {
"type": "customer",
"id": 43,
"attributes": {
"first_name": "Demo",
"last_name": "User",
"email": "demo.user@demo.com",
"telephone": "01234567890",
"address": "23-25 Fake Street",
"city": "Fakesford",
"postcode": "CM2 7HX",
"county": null,
"country": null,
"email_optin": 0,
"created_at": "2025-12-17T12:03:59.000000Z",
"updated_at": "2025-12-17T12:03:59.000000Z"
},
"relationships": {
"orders": {
"links": {
"related": "https://appx-api.mysticky.co.uk/api/v1/customers/43/orders"
}
}
},
"links": {
"self": "https://appx-api.mysticky.co.uk/api/v1/customers/43"
}
}
}