Get the caller's subscriber profile

POST 
/api/v1/notifications/manage/get-subscriber

Returns the subscriber profile for the authenticated caller, including channel registrations and notification preferences.

The following access conditions are preserved as declared intent and are not implemented by generated code: Authorized scoped domain action.

Use this in a guide: Welcome a new user with an in-app message

Request

Responses

200

Subscriber profile returned

Read the subscriber selected by authentication; no subscriber ID is accepted in this body.

Section ID: DOC-CP-notifications-api-getSubscriber#example-notifications-getSubscriber-request

Request example

{}

Illustrative response shape; omitted default fields and actual outcomes depend on the operation.

Section ID: DOC-CP-notifications-api-getSubscriber#example-notifications-getSubscriber-response

Response example

{
  "subscriberId": "example_123",
  "data": {
    "firstName": "example",
    "lastName": "example",
    "email": "user@example.com",
    "phone": "example",
    "avatarUrl": "https://example.com/resource",
    "locale": "en-US",
    "timezone": "example",
    "customData": {}
  },
  "channels": [
    {
      "channel": "CHANNEL_PUSH",
      "registered": true,
      "credentialCount": 1
    }
  ],
  "createdAt": "2026-09-16T12:00:00Z",
  "updatedAt": "2026-09-16T12:00:00Z",
  "globalPreferences": {
    "enabled": true,
    "channels": {
      "inApp": true,
      "push": true,
      "email": true,
      "sms": true,
      "chat": true
    }
  },
  "workflowPreferences": [
    {
      "workflowId": "example_123",
      "workflowName": "example",
      "critical": true,
      "tags": [
        "example"
      ],
      "channels": {
        "inApp": true,
        "push": true,
        "email": true,
        "sms": true,
        "chat": true
      }
    }
  ]
}

Document ID: DOC-CP-notifications-api-getSubscriber. Section identities and revisions.

Section	Stable reference
Get the caller's subscriber profile	DOC-CP-notifications-api-getSubscriber#overview
Request	DOC-CP-notifications-api-getSubscriber#request
Responses	DOC-CP-notifications-api-getSubscriber#responses