Gorgias helpdesk sidebar card

GET /integrations/gorgias/customer

Scope	customers:read
Customer session token	Not accepted: call from your server with an API key
Rate limit class	read (limits)
Idempotency key	Not used
MCP tool	charm_get_gorgias_customer_card

Loyalty state shaped for the Gorgias HTTP-integration sidebar. A flat overview (balance, points expiry, tier, how long it lasts, next tier and the gap to it, member since) plus three nested sections, each of which Gorgias draws as its own accordion: discount_codes (every unused reward code the customer holds, as code_1…n), referral (code + link) and timeline (the eight most recent history rows as event_1…8). Gorgias sorts by key, so those section names also fix the running order. Reward and history text is written in the shop’s storefront language, expiry wording included. Lists are numbered keys rather than arrays because Gorgias renders an array either as one section per item or as a comma-joined paragraph; a section whose content is empty is omitted whole, so a shop without a referral program gets no referral accordion. customer_id is returned so a Gorgias action button can template it into a POST against the write endpoints. A non-member returns 200 {found: false} with the e-mail that was looked up — a normal helpdesk outcome, not an error.

Parameters

Name	In	Type	Description
email	query	string	The ticket customer’s e-mail (exact match).

Response 200

Returns GorgiasCustomerCard.

Field	Type	Description
found	boolean

{
  "found": false
}

Example

curl -X GET "https://charm.appfleece.app/api/v1/integrations/gorgias/customer" \
  -H "Authorization: Bearer chrm_live_..."

Errors

unauthorized · invalid_token · insufficient_scope · access_required · validation_error · rate_limited

Every error body carries code, message, request_id and a doc_url pointing at the matching entry in the error catalog.