SQsquarespace
Profiles

List profiles

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

get/1.0/profiles

Request

Query parameters

sortDirectionstring

Identifies the sort direction of the result list; asc for ascending or dsc for descending. If not specified, the returned list is in descending order.

sortFieldstring

Identifies the sort field of the result list. Values include: createdOn, id, email, or lastName. If not specified, the returned list is sorted by id.

filterstring

Semicolon separated list used to filter profile results. Values include: isCustomer and/or hasAccount, or email. The email filter cannot be used with isCustomer or hasAccount.

emailstring

Email address filter (URL-encoded, case insensitive).

cursorstring

Identifies where the next page of results should begin. Should be the value of pagination.nextPageCursor from a previous response. Cannot be used with other parameters.

Headers

Authorizationstring required

API key or OAuth access token

User-Agentstring required

User Agent

Response

A paginated list of profiles.

Example response

{
  "pagination": {
    "hasNextPage": true,
    "nextPageCursor": "ewogICJhIiA6ICI2OWNhOWExZjgxNGMwYTY0MmIwMTIzYzkiLAogICJiIiA6ICJJRCIKfQ",
    "nextPageUrl": "/1.0/profiles?cursor=ewogICJhIiA6ICI2OWNhOWExZjgxNGMwYTY0MmIwMTIzYzkiLAogICJiIiA6ICJJRCIKfQ"
  },
  "profiles": [
    {
      "address": {
        "address1": "459 Broadway",
        "city": "New York",
        "countryCode": "US",
        "firstName": "Bob",
        "lastName": "Loblaw",
        "phone": "5553334444",
        "postalCode": "10003",
        "state": "NY"
      },
      "transactionsSummary": {
        "totalDonationAmount": {
          "value": 49.99
        },
        "totalOrderAmount": {
          "value": 49.99
        },
        "totalRefundAmount": {
          "value": 49.99
        }
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.