Is AI recommending you? Ask Contentstack Canoe for free
Is AI recommending your brand? Find out with Contentstack Canoe for free
Contentstack.comAcademyLogin
CS-log-dark.svgCS-log-dark.svg
  • Changelog
  • APIs
  • SDKs

Platform

  • Solution Center
  • Marketplace
  • Changelog
  • Developers & IT
  • Business users
  • Digital leaders
  • Developer Fast Track
  • Plans & Pricing

Solutions

  • Retail
  • Travel and tourism
  • Financial services
  • Technology
  • Manufacturing
  • E-commerce
  • Localization
  • Personalization
  • Portals and knowledge bases

Resources

  • Academy
  • Docs
  • Contentstack for Developers
  • Product updates
  • Contentstack on Contentstack
  • Blog
  • Insights and analyst reports
  • The Forrester Wave™: Digital Experience Platforms, Q4 2025
  • Webinars
  • Podcasts
  • Glossary
  • Content generative library
  • Community
  • Headless CMS
  • Composable AXP
  • Personalization
  • CDP

Customers

  • Case Studies
  • Customer Care
  • Contentstack Experience Awards
  • Customer support

Partners

  • Overview
  • Find a partner
  • Login

Company

  • About us
  • News
  • Customer support portal
  • Contact

Social

  • Facebook
  • LinkedIn
  • Instagram
  • GitHub
  • YouTube
  • Discord
  • X
LegalTermsPrivacyTrust Center

Cookie settings

Copyright © 2026 Contentstack Inc. All rights reserved.
/
  1. Home
  2. APIs
  3. Lytics API
  4. Profiles

Profiles

markdownView as Markdown

Get and delete user profiles.

Get profile attributes

GEThttps://api.lytics.io/v2/attributes/{table}/{key}/{value}

Get profile attributes for a user.

Sample Response
Status|200 OK
123456
{
  "_meta": {},
  "data": {},
  "request_id": "string",
  "status": 0
}

Update all profile attributes

PUThttps://api.lytics.io/v2/attributes/{table}/{key}/{value}

Update all of the profile attributes for a user.

Sample Request
1
{}
Sample Response
Status|200 OK
123456
{
  "_meta": {},
  "data": {},
  "request_id": "string",
  "status": 0
}

Update some profile attributes

PATCHhttps://api.lytics.io/v2/attributes/{table}/{key}/{value}

Update some of the profile attributes for a user.

Sample Request
1
{}
Sample Response
Status|200 OK
123456
{
  "_meta": {},
  "data": {},
  "request_id": "string",
  "status": 0
}

Delete profile attributes

DELETEhttps://api.lytics.io/v2/attributes/{table}/{key}/{value}

Delete profile attributes for a user.

Sample Response
Status|200 OK
123456
{
  "_meta": {},
  "data": {},
  "request_id": "string",
  "status": 0
}

Get the status of a user profile deletion

GEThttps://api.lytics.io/v2/identity/deletestatus/{request_id}

Get the status of a GDPR-compliant user profile deletion request

Sample Response
Status|200 OK
123456789101112
{
  "_meta": {},
  "data": {
    "completed": true,
    "request_id": "string",
    "requested": "string",
    "state": "string",
    "submitted": "string"
  },
  "request_id": "string",
  "status": 0
}

Get a user profile (POST)

POSThttps://api.lytics.io/v2/identity/lookup

Get a user profile by identity key/value using POST

Sample Request
1
{}
Sample Response
Status|200 OK
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104
{
  "_meta": {},
  "data": {
    "entity": {},
    "field_provenance": {
      "property1": {
        "compacted": true,
        "configured_merge_op": "string",
        "contributors": [
          {
            "excluded": true,
            "excluded_because": "string",
            "fragment": [
              {
                "key": "string",
                "value": "string"
              }
            ],
            "kind": "string",
            "label": "string",
            "streams": [
              "string"
            ],
            "value": {},
            "won": true,
            "written": "string"
          }
        ],
        "merge_op": "string",
        "no_winner": "string",
        "truncated": true,
        "winner_take_all": true
      },
      "property2": {
        "compacted": true,
        "configured_merge_op": "string",
        "contributors": [
          {
            "excluded": true,
            "excluded_because": "string",
            "fragment": [
              {
                "key": "string",
                "value": "string"
              }
            ],
            "kind": "string",
            "label": "string",
            "streams": [
              "string"
            ],
            "value": {},
            "won": true,
            "written": "string"
          }
        ],
        "merge_op": "string",
        "no_winner": "string",
        "truncated": true,
        "winner_take_all": true
      }
    },
    "field_sources": {
      "property1": [
        "string"
      ],
      "property2": [
        "string"
      ]
    },
    "fragments": [
      {
        "conflict": true,
        "conflicts_with": "string",
        "created": "string",
        "keys": [
          {
            "key": "string",
            "value": "string"
          }
        ],
        "modified": "string",
        "neighbor_limit": true,
        "neighbors": [
          {
            "key": "string",
            "value": "string"
          }
        ],
        "streams": [
          "string"
        ]
      }
    ],
    "keys": [
      {
        "key": "string",
        "value": "string"
      }
    ]
  },
  "request_id": "string",
  "status": 0
}

Bulk delete user profiles

DELETEhttps://api.lytics.io/v2/identity/queue/bulk/{table}/{field}

Queue bulk GDPR-compliant deletion requests for multiple user profiles

Sample Request
1
{}
Sample Response
Status|202
123456789101112131415
{
  "_meta": {},
  "data": {
    "errors": {
      "property1": "string",
      "property2": "string"
    },
    "successes": {
      "property1": "string",
      "property2": "string"
    }
  },
  "request_id": "string",
  "status": 0
}

Get a user profile (GET)

GEThttps://api.lytics.io/v2/identity/{table}/{key}/{value}

Get a user profile by identity key/value

Sample Response
Status|200 OK
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104
{
  "_meta": {},
  "data": {
    "entity": {},
    "field_provenance": {
      "property1": {
        "compacted": true,
        "configured_merge_op": "string",
        "contributors": [
          {
            "excluded": true,
            "excluded_because": "string",
            "fragment": [
              {
                "key": "string",
                "value": "string"
              }
            ],
            "kind": "string",
            "label": "string",
            "streams": [
              "string"
            ],
            "value": {},
            "won": true,
            "written": "string"
          }
        ],
        "merge_op": "string",
        "no_winner": "string",
        "truncated": true,
        "winner_take_all": true
      },
      "property2": {
        "compacted": true,
        "configured_merge_op": "string",
        "contributors": [
          {
            "excluded": true,
            "excluded_because": "string",
            "fragment": [
              {
                "key": "string",
                "value": "string"
              }
            ],
            "kind": "string",
            "label": "string",
            "streams": [
              "string"
            ],
            "value": {},
            "won": true,
            "written": "string"
          }
        ],
        "merge_op": "string",
        "no_winner": "string",
        "truncated": true,
        "winner_take_all": true
      }
    },
    "field_sources": {
      "property1": [
        "string"
      ],
      "property2": [
        "string"
      ]
    },
    "fragments": [
      {
        "conflict": true,
        "conflicts_with": "string",
        "created": "string",
        "keys": [
          {
            "key": "string",
            "value": "string"
          }
        ],
        "modified": "string",
        "neighbor_limit": true,
        "neighbors": [
          {
            "key": "string",
            "value": "string"
          }
        ],
        "streams": [
          "string"
        ]
      }
    ],
    "keys": [
      {
        "key": "string",
        "value": "string"
      }
    ]
  },
  "request_id": "string",
  "status": 0
}

Delete a user profile

DELETEhttps://api.lytics.io/v2/identity/{table}/{key}/{value}

Delete a user profile, compliant with GDPR deletion requests

Sample Response
Status|202
123456789101112
{
  "_meta": {},
  "data": {
    "completed": true,
    "request_id": "string",
    "requested": "string",
    "state": "string",
    "submitted": "string"
  },
  "request_id": "string",
  "status": 0
}
Hide Parameters

URL Parameters

tablerequiredstring

The table (e.g. user)

keyrequiredstring

Identity Key (e.g. email)

valuerequiredstring

Value (e.g. [email protected])

Query Parameters

account_idoptionalstring

The account ID. Defaults to the user's default account.

Headers

Authorizationoptionalstring

Hide Parameters

URL Parameters

tablerequiredstring

The table (e.g. user)

keyrequiredstring

Identity Key (e.g. email)

valuerequiredstring

Value (e.g. [email protected])

Query Parameters

account_idoptionalstring

The account ID. Defaults to the user's default account.

Headers

Authorizationoptionalstring

Hide Parameters

URL Parameters

tablerequiredstring

The table (e.g. user)

keyrequiredstring

Identity Key (e.g. email)

valuerequiredstring

Value (e.g. [email protected])

Query Parameters

account_idoptionalstring

The account ID. Defaults to the user's default account.

Headers

Authorizationoptionalstring

Hide Parameters

URL Parameters

tablerequiredstring

The table (e.g. user)

keyrequiredstring

Identity Key (e.g. email)

valuerequiredstring

Value (e.g. [email protected])

Query Parameters

account_idoptionalstring

The account ID. Defaults to the user's default account.

Headers

Authorizationoptionalstring

Hide Parameters

URL Parameters

request_idrequiredstring

The GDPR delete request ID

Query Parameters

account_idoptionalstring

The account ID. Defaults to the user's default account.

Headers

Authorizationoptionalstring

Hide Parameters

Query Parameters

account_idoptionalstring

The account ID. Defaults to the user's default account.

field_blocklistoptionalstring

Fields to exclude (e.g. email,city)

hash_piioptionalstring

Return PII/private fields SHA256-hashed instead of plain (only fields the caller may already read; never widens access)

Headers

Authorizationoptionalstring

Hide Parameters

URL Parameters

tablerequiredstring

The table (e.g. user)

fieldrequiredstring

Identity field (e.g. email)

Query Parameters

account_idoptionalstring

The account ID. Defaults to the user's default account.

Headers

Authorizationoptionalstring

Hide Parameters

URL Parameters

tablerequiredstring

The table (e.g. user)

keyrequiredstring

Identity Key (e.g. email)

valuerequiredstring

Value (e.g. [email protected])

Query Parameters

account_idoptionalstring

The account ID. Defaults to the user's default account.

field_blocklistoptionalstring

Fields to exclude (e.g. email,city)

hash_piioptionalstring

Return PII/private fields SHA256-hashed instead of plain (only fields the caller may already read; never widens access)

Headers

Authorizationoptionalstring

Hide Parameters

URL Parameters

tablerequiredstring

The table (e.g. user)

keyrequiredstring

Identity Key (e.g. email)

valuerequiredstring

Value (e.g. [email protected])

Query Parameters

account_idoptionalstring

The account ID. Defaults to the user's default account.

Headers

Authorizationoptionalstring