Profiles

Get profiles

Retrieves information for specific profiles. The response contains a list of up to 50 Profiles. Multiple Profiles can be retrieved by providing a comma-separated list of profile ids.

get/1.0/profiles/{profileIdCsvs}

Request

Base URL
https://api.squarespace.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/squarespace/apis/commerce-api/docs/1.0/profiles/:profileIdCsvs/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

profileIdCsvsstring required

Specifies the profiles to retrieve. Multiple Profiles can be retrieved by providing a comma-separated list of profile ids.

Headers

Authorizationstring required

API key or OAuth access token

User-Agentstring required

User Agent

Response

The requested profiles.

Example response

{
  "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.