Account
Mints a fresh access token from a refresh token.
Authorization
clientKey The connection's key (Dashboard → Channels → Headless API; keys are also listed in Settings → Connections). pk_… public keys are for browser code and only work from a website listed on the connection (a website connection never accepts *; a development connection on a dev store also allows localhost); sk_… private keys are for servers and native apps and need no Origin.
In: header
Header Parameters
Your connection's key (Dashboard → Channels → Headless API; keys are also listed in Settings → Connections). pk_… public keys are for browser code and only work from a website listed on the connection (a website connection never accepts *; a development connection on a dev store also allows localhost); sk_… private keys are for servers and native apps and need no Origin.
Your own correlation id (8–128 chars, ^[A-Za-z0-9_.:-]+$). Echoed back on the response and on every log line of the request; one is generated when you omit it.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/auth/token/refresh" \ -H "X-Client-Key: {{clientKey}}" \ -H "Content-Type: application/json" \ -d '{ "refresh_token": "clr_9a1b2c3d4e5f60718293a4b5c6d7e8f9" }'{ "status": "success", "message": "Token refreshed", "data": { "token": "cli_5f2c9b3e8a7d6c1b4a0e9f8d7c6b5a4e3", "access_token": "cli_5f2c9b3e8a7d6c1b4a0e9f8d7c6b5a4e3", "refresh_token": "clr_9a1b2c3d4e5f60718293a4b5c6d7e8f9", "token_type": "Bearer", "expires_in": 3600, "expires_at": "2026-09-25T16:58:00+01:00", "refresh_expires_in": 2592000, "refresh_expires_at": "2026-10-25T15:58:00+01:00", "platform": "client_web", "user": { "id": "019b0c4d-5e6f-7a8b-9c0d-1e2f3a4b5c51", "name": "Alex Morgan", "email": "[email protected]", "phone": "+12025550148", "avatar": "https://media.usequeek.com/uploads/avatars/alex-morgan.jpg", "country": "United States", "state": "New York", "region": null, "city": "New York", "address": "48 Greenwich Avenue, New York, NY 10011", "map_lat": "40.7355000", "map_lng": "-74.0020000", "is_rider": false, "rider_approved": false, "profile_complete": true, "sms_marketing_consent": { "state": "subscribed", "opt_in_level": "SINGLE_OPT_IN", "consent_updated_at": "2026-11-11T10:00:00+01:00" }, "metafields": {} } }}Returns the signed-in customer’s account. Needs the customer bearer bound to this store in addition to the key.
Authorization
clientKey customerToken The connection's key (Dashboard → Channels → Headless API; keys are also listed in Settings → Connections). pk_… public keys are for browser code and only work from a website listed on the connection (a website connection never accepts *; a development connection on a dev store also allows localhost); sk_… private keys are for servers and native apps and need no Origin.
In: header
The customer access credential from any sign-in session answer (access_token). Account operations only — send as Authorization: Bearer <access_token> ALONGSIDE X-Client-Key. It is bound to one store: a credential issued for another vendor answers 403 here.
In: header
Header Parameters
Your connection's key (Dashboard → Channels → Headless API; keys are also listed in Settings → Connections). pk_… public keys are for browser code and only work from a website listed on the connection (a website connection never accepts *; a development connection on a dev store also allows localhost); sk_… private keys are for servers and native apps and need no Origin.
Your own correlation id (8–128 chars, ^[A-Za-z0-9_.:-]+$). Echoed back on the response and on every log line of the request; one is generated when you omit it.
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/auth/me" \ -H "X-Client-Key: {{clientKey}}"{ "status": "success", "message": "Authenticated", "data": { "user": { "id": "019b0c4d-5e6f-7a8b-9c0d-1e2f3a4b5c51", "name": "Alex Morgan", "email": "[email protected]", "phone": "+12025550148", "avatar": "https://media.usequeek.com/uploads/avatars/alex-morgan.jpg", "country": "United States", "state": "New York", "region": null, "city": "New York", "address": "48 Greenwich Avenue, New York, NY 10011", "map_lat": "40.7355000", "map_lng": "-74.0020000", "is_rider": false, "rider_approved": false, "profile_complete": true, "sms_marketing_consent": { "state": "subscribed", "opt_in_level": "SINGLE_OPT_IN", "consent_updated_at": "2026-11-11T10:00:00+01:00" }, "metafields": {} } }}Updates the signed-in customer’s profile.
Authorization
clientKey customerToken The connection's key (Dashboard → Channels → Headless API; keys are also listed in Settings → Connections). pk_… public keys are for browser code and only work from a website listed on the connection (a website connection never accepts *; a development connection on a dev store also allows localhost); sk_… private keys are for servers and native apps and need no Origin.
In: header
The customer access credential from any sign-in session answer (access_token). Account operations only — send as Authorization: Bearer <access_token> ALONGSIDE X-Client-Key. It is bound to one store: a credential issued for another vendor answers 403 here.
In: header
Header Parameters
Your connection's key (Dashboard → Channels → Headless API; keys are also listed in Settings → Connections). pk_… public keys are for browser code and only work from a website listed on the connection (a website connection never accepts *; a development connection on a dev store also allows localhost); sk_… private keys are for servers and native apps and need no Origin.
Your own correlation id (8–128 chars, ^[A-Za-z0-9_.:-]+$). Echoed back on the response and on every log line of the request; one is generated when you omit it.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X PATCH "https://example.com/auth/me" \ -H "X-Client-Key: {{clientKey}}" \ -H "Content-Type: application/json" \ -d '{ "name": "Alex Morgan", "phone": "+12025550148", "city": "New York", "address": "48 Greenwich Avenue, New York, NY 10011" }'{ "status": "success", "message": "Profile updated", "data": { "user": { "id": "019b0c4d-5e6f-7a8b-9c0d-1e2f3a4b5c51", "name": "Alex Morgan", "email": "[email protected]", "phone": "+12025550148", "avatar": "https://media.usequeek.com/uploads/avatars/alex-morgan.jpg", "country": "United States", "state": "New York", "region": null, "city": "New York", "address": "48 Greenwich Avenue, New York, NY 10011", "map_lat": "40.7355000", "map_lng": "-74.0020000", "is_rider": false, "rider_approved": false, "profile_complete": true, "sms_marketing_consent": { "state": "subscribed", "opt_in_level": "SINGLE_OPT_IN", "consent_updated_at": "2026-11-11T10:00:00+01:00" }, "metafields": {} } }}Signs out the customer on this device. Answers {status, message} (Logged out) with no data.
Authorization
clientKey customerToken The connection's key (Dashboard → Channels → Headless API; keys are also listed in Settings → Connections). pk_… public keys are for browser code and only work from a website listed on the connection (a website connection never accepts *; a development connection on a dev store also allows localhost); sk_… private keys are for servers and native apps and need no Origin.
In: header
The customer access credential from any sign-in session answer (access_token). Account operations only — send as Authorization: Bearer <access_token> ALONGSIDE X-Client-Key. It is bound to one store: a credential issued for another vendor answers 403 here.
In: header
Header Parameters
Your connection's key (Dashboard → Channels → Headless API; keys are also listed in Settings → Connections). pk_… public keys are for browser code and only work from a website listed on the connection (a website connection never accepts *; a development connection on a dev store also allows localhost); sk_… private keys are for servers and native apps and need no Origin.
Your own correlation id (8–128 chars, ^[A-Za-z0-9_.:-]+$). Echoed back on the response and on every log line of the request; one is generated when you omit it.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/auth/logout" \ -H "X-Client-Key: {{clientKey}}" \ -H "Content-Type: application/json" \ -d '{ "refresh_token": "clr_9a1b2c3d4e5f60718293a4b5c6d7e8f9" }'{ "status": "success", "message": "Logged out"}