Get Customer

Retrieve a customer

GET/api/customers/{id}

Use it in a workflow

Add a step and choose the Gorgias connector.
Pick the Get Customer action (under Customers).
Fill in the fields below, then reference the result from later steps as {{getCustomer.response.data}}.

Request

Path parameters

idintegerrequired

The ID of the customer to retrieve.

Query parameters

relationshipsarray<enum>

Names of relations that should be included in returned data.

Default []

Response

Returns 200 with an object. Read it in later steps with {{getCustomer.response.data.<field>}}.

idinteger

ID of the customer.

channelsarray<object>

The [customer's contact channels](#the-customerchannel-object).

idinteger

ID of the customer channel.

created_datetimestring | null

When the customer was created.

emailstring | null

Primary email address of the customer.

external_idstring | null

ID of the customer in a foreign system (Stripe, Aircall, etc...). This field is not used by Gorgias, feel free to set it as you wish.

firstnamestring

First name of the customer.

integrationsobject

Data coming from integrations (Shopify, Recharge, HTTP, etc...) associated with the customer. Keys of the object are integration IDs, values are raw data collected from the integrations.

languagestring | null

The customer's preferred language (format: ISO_639-1).

One ofaaabafaksqamaranhyasavaeayazbabmeubebnbhbibsbrbgmycachcezhcucvkwcocrcsdadvnldzen

lastnamestring

Last name of the customer.

namestring | null

Full name of the customer.

notestring | null

A note associated with the customer.

timezonestring | null

The customer's preferred timezone (format: IANA timezone name).

One ofAfrica/AbidjanAfrica/AccraAfrica/Addis_AbabaAfrica/AlgiersAfrica/AsmaraAfrica/AsmeraAfrica/BamakoAfrica/BanguiAfrica/BanjulAfrica/BissauAfrica/BlantyreAfrica/BrazzavilleAfrica/BujumburaAfrica/CairoAfrica/CasablancaAfrica/CeutaAfrica/ConakryAfrica/DakarAfrica/Dar_es_SalaamAfrica/DjiboutiAfrica/DoualaAfrica/El_AaiunAfrica/FreetownAfrica/GaboroneAfrica/HarareAfrica/JohannesburgAfrica/JubaAfrica/KampalaAfrica/KhartoumAfrica/KigaliAfrica/KinshasaAfrica/LagosAfrica/LibrevilleAfrica/LomeAfrica/LuandaAfrica/LubumbashiAfrica/LusakaAfrica/MalaboAfrica/MaputoAfrica/MaseruDefault "UTC"

updated_datetimestring | null

When the customer was last updated.

external_dataarray<object>

A list of external (third-party) data rows that this user has.

ecommerce_dataobject

The ecommerce data of the customer, keyed by store uuid.

json

{
  "id": 3924,
  "channels": [
    {
      "id": 49182
    }
  ],
  "created_datetime": "2019-04-13T03:27:56.973873",
  "email": "john@example.com",
  "external_id": "customer-84203241",
  "firstname": "John",
  "integrations": {
    "6": {
      "orders": [
        {
          "id": 772803526679,
          "total_tax": "0.02",
          "created_at": "2018-12-04T03:29:37-08:00",
          "line_items": [
            {
              "id": 1760305053719,
              "sku": "0987654321",
              "name": "Acidulous candy",
              "grams": 10,
              "price": "0.10",
              "title": "acidulous candy",
              "taxable": true,
              "quantity": 1,
              "price_set": {
                "shop_money": {
                  "amount": "0.10",
                  "currency_code": "USD"
                },
                "presentment_money": {
                  "amount": "0.10",
                  "currency_code": "USD"
                }
              },
              "tax_lines": [
                {
                  "rate": 0.2,
                  "price": "0.02",
                  "title": "tva",
                  "price_set": {
                    "shop_money": {
                      "amount": "0.02",
                      "currency_code": "USD"
                    },
                    "presentment_money": {
                      "amount": "0.02",
                      "currency_code": "USD"
                    }
                  }
                }
              ],
              "product_id": 8345093387,
              "variant_id": 28442938955,
              "total_discount": "0.00",
              "requires_shipping": true,
              "fulfillment_status": null,
              "total_discount_set": {
                "shop_money": {
                  "amount": "0.00",
                  "currency_code": "USD"
                },
                "presentment_money": {
                  "amount": "0.00",
                  "currency_code": "USD"
                }
              },
              "fulfillment_service": "manual",
              "fulfillable_quantity": 1
            }
          ],
          "contact_email": "marie@gorgias.io",
          "billing_address": {
            "zip": "94103",
            "city": "SAN FRANCISCO",
            "name": "Marie Curie",
            "country": "United States",
            "address1": "52 Washburn Street",
            "address2": "",
            "province": "California",
            "last_name": "Curie",
            "first_name": "Marie",
            "country_code": "US",
            "province_code": "CA"
          }
        }
      ],
      "customer": {
        "id": 667928133655,
        "note": "",
        "tags": "",
        "email": "marie@gorgias.io",
        "first_name": "Marie",
        "last_name": "Curie",
        "orders_count": 1,
        "default_address": {
          "id": 707106144279,
          "zip": "94103",
          "city": "SAN FRANCISCO",
          "name": "Marie Curie",
          "country": "United States",
          "default": true,
          "address1": "52 Washburn Street",
          "address2": "",
          "province": "California",
          "last_name": "Curie",
          "first_name": "Marie",
          "customer_id": 667928133655,
          "country_code": "US",
          "country_name": "United States",
          "province_code": "CA"
        }
      },
      "__integration_type__": "shopify"
    }
  },
  "language": "fr",
  "lastname": "Smith",
  "name": "John Smith",
  "note": "Our best customer.",
  "timezone": "UTC"
}

Need more? See the Gorgias guide for connection setup and behaviour shared by every action.

Was this page helpful?