Skip to content
Pidgely Docs

API reference · Commerce (stores)

List a store's customers

GEThttps://api.pidgely.com/commerce/stores/{id}/customers
View as Markdown

Newest first. contact_id is the organization's contact with the same e-mail.

Authorization: Bearer pdg_…. An API key with full_access. A sending_access key gets 401 restricted_api_key.

Path parameters

Name Type Required Description
id string Yes Store id. UUID.

Query parameters

Name Type Required Description
limit integer No Page size (1-100, default 20). Between 1 and 100.
after string No Id of the last item of the previous page (older items). UUID.
before string No Id of the first item of the current page (newer items). UUID.

Request

This endpoint is not in the SDKs yet; call it over HTTP.

cURL
curl -X GET 'https://api.pidgely.com/commerce/stores/0199d8a2-6f3c-7c51-9e2a-3b1f0c6d4e21/customers' \
  -H "Authorization: Bearer $PIDGELY_API_KEY"

Response

200 OK

JSON
{
  "object": "list",
  "has_more": false,
  "data": [
    {
      "object": "commerce",
      "id": "0199d8a2-6f3c-7c51-9e2a-3b1f0c6d4e21",
      "external_id": "0199d8a2-6f3c-7c51-9e2a-3b1f0c6d4e21",
      "contact_id": "0199d7f4-5d7b-7a2c-b4e1-9f3c2a6d8e05",
      "email": "steve@example.com",
      "first_name": "Steve",
      "last_name": "Wozniak",
      "phone": "phone",
      "accepts_marketing": false,
      "orders_count": 1,
      "total_spent": 1,
      "currency": "currency",
      "created_at": "2026-10-12 16:44:41.000000+00",
      "updated_at": "2026-10-12 16:44:41.000000+00"
    }
  ]
}

Response fields

Name Type Required Description
object string Yes Object type. One of list.
has_more boolean Yes Whether another page exists.
data object[] Yes Items of this page.
data[].object string Yes Object type. One of customer.
data[].id string Yes Unique id (UUID). UUID.
data[].external_id string Yes —
data[].contact_id string | null No UUID.
data[].email string Yes Email address.
data[].first_name string Yes First name, up to 200 characters. Available as {{{FIRST_NAME}}} in broadcasts.
data[].last_name string Yes Last name, up to 200 characters. Available as {{{LAST_NAME}}} in broadcasts.
data[].phone string No —
data[].accepts_marketing boolean | null No —
data[].orders_count integer No —
data[].total_spent integer No Minor units of the currency (cents). Format: int64.
data[].currency string No —
data[].created_at string | null No Creation time, YYYY-MM-DD HH:MM:SS.ffffff+00 (UTC). Format: date-time.
data[].updated_at string | null No Format: date-time.

Errors

Errors have the shape {"statusCode", "name", "message"}. See Errors for the full list.

Status Name When
401 missing_api_key, restricted_api_key No Authorization: Bearer header, or a sending_access key called an endpoint that needs full_access.
403 invalid_api_key, validation_error The API key is invalid or revoked, or the request is not allowed for this account (unverified domain, plan limit, paused account).
404 not_found The resource does not exist in this account (or the id is not a valid UUID).
422 validation_error A field is missing or invalid; message names it.
429 rate_limit_exceeded Too many requests per second. Wait for Retry-After seconds.