---
title: "List profiles"
method: GET
path: "/1.0/profiles"
tags: ["Profiles"]
---

# List profiles

`GET /1.0/profiles`

## Request

- Base URL: `https://api.squarespace.com`
- URL: `https://api.squarespace.com/1.0/profiles`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/squarespace/apis/commerce-api/docs/1.0/profiles/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieves all profiles; profiles can be filtered and sorted. The response contains up to 50 Profiles and supports dynamic cursors for pagination.

## Query parameters

- `sortDirection` string
- `sortField` string
- `filter` string
- `email` string
- `cursor` string

## Headers

- `Authorization` string, required
- `User-Agent` string, required

## Response `200`

A paginated list of profiles.

- PaginatedProfileListResponse
  - `pagination` object
    - `hasNextPage` boolean
    - `nextPageCursor` string
    - `nextPageUrl` string
  - `profiles` Profile[]
    - `acceptsMarketing` boolean: Indicates whether the profile opted to receive marketing.
    - `address` Address: Customer's shipping address provided at checkout or, for recurring subscription orders, the customer's current mailing address.
      - `address1` string: Primary street address
      - `address2` string: Secondary address line
      - `city` string: City
      - `countryCode` string: ISO 3166-1 alpha-2 country code
      - `firstName` string: First name
      - `lastName` string: Last name
      - `phone` string: Phone number
      - `postalCode` string: Postal or ZIP code
      - `state` string: State or province
    - `createdOn` string, date-time: ISO 8601 UTC date and time string; represents when the profile was created.
    - `email` string: Profile email address.
    - `firstName` string: Profile first name.
    - `hasAccount` boolean: Indicates whether the profile has an account with the website.
    - `id` string: Unique Profile id.
    - `isCustomer` boolean: Indicates whether the profile has any commerce orders or donations with the website.
    - `lastName` string: Profile last name.
    - `transactionsSummary` TransactionsSummary: Summary of profile's commerce transactions. If a profile has no commerce transactions, the object is still returned with null or 0 values. This information is calculated asynchronously; there may be a slight delay between when an order is created, and when it's reflected in the object.
      - `donationCount` integer: Count of donations submitted.
      - `firstDonationSubmittedOn` string, date-time: ISO 8601 UTC date and time string; represents when the profile's first donation was submitted.
      - `firstOrderSubmittedOn` string, date-time: ISO 8601 UTC date and time string; represents when the profile's first order was submitted.
      - `lastDonationSubmittedOn` string, date-time: ISO 8601 UTC date and time string; represents when the profile's latest donation was submitted.
      - `lastOrderSubmittedOn` string, date-time: ISO 8601 UTC date and time string; represents when the profile's latest order was submitted.
      - `orderCount` integer: Count of orders submitted.
      - `totalDonationAmount` MonetaryAmount: A monetary amount with currency code and decimal value.
        - `currency` object: ISO 4217 currency code.
          - `currencyCode` string
          - `defaultFractionDigits` integer
          - `displayName` string
          - `numericCode` integer
          - `numericCodeAsString` string
          - `symbol` string
        - `value` number: Decimal monetary value.
      - `totalOrderAmount` MonetaryAmount: A monetary amount with currency code and decimal value.
        - `currency` object: ISO 4217 currency code.
          - `currencyCode` string
          - `defaultFractionDigits` integer
          - `displayName` string
          - `numericCode` integer
          - `numericCodeAsString` string
          - `symbol` string
        - `value` number: Decimal monetary value.
      - `totalRefundAmount` MonetaryAmount: A monetary amount with currency code and decimal value.
        - `currency` object: ISO 4217 currency code.
          - `currencyCode` string
          - `defaultFractionDigits` integer
          - `displayName` string
          - `numericCode` integer
          - `numericCodeAsString` string
          - `symbol` string
        - `value` number: Decimal monetary value.

## Other responses

- `400`: Bad request.
- `404`: Not found. The API version is not supported.

---

[API](https://skmtc.dev/squarespace/apis/commerce-api.md) - [All operations](https://skmtc.dev/squarespace/apis/commerce-api/llms.txt) - [OpenAPI document](https://skmtc.dev/squarespace/apis/commerce-api/revisions/5dd4b1b7cd38?raw)