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

# List profiles

`GET /profiles`

## Request

- Base URL: `https://api.pscrpt.com/v1`
- URL: `https://api.pscrpt.com/v1/profiles`
- Auth: one of:
  - HTTP bearer
  - OAuth 2
    - Authorization code: `https://api.pscrpt.com/oauth/authorize`
    - Token URL: `https://api.pscrpt.com/oauth/token` scopes: `profiles:read`

## Query parameters

- `page[limit]` integer
- `page[after]` string
- `filter[updated_at][gte]` string, date-time
- `filter[updated_at][lte]` string, date-time
- `sort` string
- `expand` string[]

## Headers

- `Postscript-Version` string, date

## Response `200`

One page of profiles.

- ProfileListEnvelope
  - `data` Profile[], required
    - `attributes` object, required
    - `consents` Consent[]: Stored marketing-consent states for the profile's identifiers.
      - `channel` string, required
      - `consented_at` string, date-time, required
      - `id` string, required
      - `identifier` Identifier
        - `created_at` string, date-time, required
        - `display_value` string, required
        - `id` string, required
        - `is_primary` boolean, required
        - `object` 'identifier', required
        - `profile_id` string, required
        - `source` string, required
        - `type` string, required
        - `updated_at` string, date-time, required
        - `value` string: Requires the `identifiers:read_value` scope.
        - `verified_at` string, date-time, required
      - `identifier_id` string, required
      - `method` string, required: How consent was collected.
      - `method_detail` string, nullable, required
      - `object` 'consent', required
      - `profile_id` string, required
      - `source` string, required: Origin derived from the credential.
      - `source_reference` string, nullable, required
      - `status` 'subscribed' | 'unsubscribed' | 'never_subscribed' | 'pending' | 'expired', required
      - `updated_at` string, date-time, required
    - `created_at` string, date-time, required
    - `id` string, required
    - `identifier_ids` IdentifierId[], required
    - `identifiers` Identifier[]
      - `created_at` string, date-time, required
      - `display_value` string, required
      - `id` string, required
      - `is_primary` boolean, required
      - `object` 'identifier', required
      - `profile_id` string, required
      - `source` string, required
      - `type` string, required
      - `updated_at` string, date-time, required
      - `value` string: Requires the `identifiers:read_value` scope.
      - `verified_at` string, date-time, required
    - `location` Location, required
      - `city` string, nullable
      - `country` string, nullable: ISO 3166-1 alpha-2.
      - `region` string, nullable
      - `timezone` string, nullable: IANA time zone name.
      - `zip` string, nullable
    - `merged_into` string, required
    - `object` 'profile', required
    - `profile_ref` string: Property-scoped compact reference, present for properties enabled for the rollout. It is not authorization or merge evidence.
    - `status` 'active' | 'merged' | 'redacted', required
    - `tags` string[], required: Managed in the Postscript app and by the Shopify customer sync.
    - `updated_at` string, date-time, required
  - `meta` Meta, required
    - `as_of` string, date-time
    - `livemode` boolean, required
    - `page` PageMeta
      - `limit` integer, required
      - `next_cursor` string, nullable, required: Pass as `page[after]`. Null on the last page.
    - `request_id` string, required
    - `resolved_from` string: The merged-away profile ID the request addressed; `data` holds the survivor.
    - `revision` string, date, required

## Other responses

- `400`: Malformed input, an unknown parameter, an unsupported filter, sort, or expand, or a mistyped ID.
- `401`: Missing or invalid API key.
- `403`: The key lacks the required scope.
- `429`: Rate limit exceeded.
- `500`: Internal error.
- `502`: Upstream provider failure.
- `503`: Temporarily unavailable.

## Changes

- **2026-10-09** `8dfa57319d25`: 3 info
  - added the new optional `query` request parameter `filter[updated_at][gte]`
  - added the new optional `query` request parameter `filter[updated_at][lte]`
  - for the `query` request parameter `page[limit]`, the max was increased from `100.00` to `500.00`
- **2026-10-06** `9a9f9d98844a`: 1 info
  - added the optional property `data/items/consents` to the response with the `200` status
- **2026-09-10** `b0075ca68afb`: 1 warning
  - changed the pattern of the `query` request parameter `sort` from `^-?(created_at|updated_at|id)(,-?(created_at|updated_at|id))*$` to `^-?(?:created_at)$`
- **2026-09-09** `e30a64c93065`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/pscrpt/apis/postscript-native-api-beta/changes/profiles/get.md)

---

[API](https://skmtc.dev/pscrpt/apis/postscript-native-api-beta.md) - [All operations](https://skmtc.dev/pscrpt/apis/postscript-native-api-beta/llms.txt) - [OpenAPI document](https://skmtc.dev/pscrpt/apis/postscript-native-api-beta/revisions/882458ee1f36?raw)