---
title: "Look up a profile"
method: GET
path: "/profiles/lookup"
tags: ["profiles"]
---

# Look up a profile

`GET /profiles/lookup`

Pass exactly one identifier or property-scoped compact profile reference. An address that moved to another profile in a merge resolves to the survivor.

## Query parameters

- `email` string, email
- `phone` string
- `external_id` string
- `profile_ref` string
- `expand` string[]

## Headers

- `Postscript-Version` string, date

## Response `200`

The profile.

- ProfileEnvelope
  - `data` Profile, required
    - `attributes` object, 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 — The response reflects data through this instant.
    - `livemode` boolean, required
    - `page` PageMeta
      - `has_more` boolean, required
      - `limit` integer, required — Granted page size.
      - `next_cursor` string, nullable — Cursor for `page[after]`, valid 7 days.
    - `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.
- `404` — No such resource in the authenticated property.
- `429` — Rate limit exceeded.
- `500` — Internal error.
- `502` — Upstream provider failure.
- `503` — Temporarily unavailable.

---

[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-service-production.skmtc.workers.dev/v1/apis/pscrpt/postscript-native-api-beta/revisions/a9a161774352/schema)
