---
updatedAt: 2025-09-15T21:39:39.000Z
agentTools:
  projectIndex: https://developers.pushly.com/llms.txt
---

# Get Subscriber

Performs a lookup to get a subscriber document. Identifier types currently supported are `pushly_id` and `external_id`.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Subscribers API",
    "description": "This API handles operations involving Subscribers and their subscriptions.",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://api.pushly.com/"
    }
  ],
  "paths": {
    "/domains/{domainId}/subscribers/{subscriberIdentifierType}/{subscriberIdentifier}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/domainId"
        },
        {
          "$ref": "#/components/parameters/subscriberIdentifierType"
        },
        {
          "$ref": "#/components/parameters/subscriberIdentifier"
        }
      ],
      "get": {
        "summary": "Get Subscriber",
        "description": "Performs a lookup to get a subscriber document. Identifier types currently supported are `pushly_id` and `external_id`.",
        "tags": [
          "Subscribers"
        ],
        "operationId": "subscriber-get-document",
        "responses": {
          "200": {
            "description": "Successfully returned a subscriber document.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "data"
                  ],
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "success"
                      ]
                    },
                    "data": {
                      "$ref": "#/components/schemas/Subscriber"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Forbidden"
          },
          "404": {
            "description": "Not Found"
          }
        }
      }
    }
  },
  "components": {
    "parameters": {
      "domainId": {
        "name": "domainId",
        "in": "path",
        "description": "ID of domain that the subscriber belongs to.",
        "required": true,
        "schema": {
          "type": "integer",
          "format": "int64"
        }
      },
      "subscriberIdentifierType": {
        "name": "subscriberIdentifierType",
        "in": "path",
        "description": "Type of identifier being used to search for subscriber.",
        "required": true,
        "schema": {
          "$ref": "#/components/schemas/IdentifierType"
        }
      },
      "subscriberIdentifier": {
        "name": "subscriberIdentifier",
        "in": "path",
        "description": "Subscriber Identifier used to query for the Subscriber document.",
        "required": true,
        "schema": {
          "type": "string"
        }
      }
    },
    "schemas": {
      "IdentifierType": {
        "type": "string",
        "enum": [
          "pushly_id",
          "external_id"
        ]
      },
      "Identifier": {
        "type": "object",
        "properties": {
          "external_id": {
            "type": "string",
            "examples": [
              "client_identifier_555"
            ]
          },
          "viafoura_id": {
            "type": "string",
            "examples": [
              "26db7b0447"
            ]
          }
        }
      },
      "Subscriber": {
        "type": "object",
        "properties": {
          "pushly_id": {
            "type": "string",
            "examples": [
              "e4b0929dab1d4ae4ae346aa4a4f32418"
            ]
          },
          "domain_id": {
            "type": "integer",
            "format": "int64",
            "examples": [
              1099
            ]
          },
          "identifiers": {
            "type": "object",
            "schema": {
              "$ref": "#/components/schemas/Identifier"
            },
            "examples": [
              {
                "external_id": "abc123",
                "viafoura_id": "efg456"
              }
            ]
          },
          "devices": {
            "type": "array",
            "schema": "$ref '#/components/schema/Device'",
            "items": {
              "allOf": [
                {
                  "$ref": "#/components/schemas/Device"
                }
              ]
            }
          },
          "deleted": {
            "type": "boolean"
          },
          "deleted_at": {
            "type": "string",
            "format": "date-time"
          },
          "deleted_reason": {
            "type": "string",
            "examples": [
              "Subscriber document merged with another document."
            ]
          },
          "profile": {
            "$ref": "#/components/schemas/Profile"
          },
          "keywords": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "examples": [
              [
                "push notifications",
                "web push",
                "native push notifications"
              ]
            ]
          }
        }
      },
      "Profile": {
        "type": "object",
        "examples": [
          {
            "invited_to_beta": true,
            "client_internal_subscriber_id": "poweruser_9001",
            "purchases": 108,
            "favorited_articles": [
              102523,
              334455,
              90210
            ]
          }
        ]
      },
      "Device": {
        "type": "object",
        "properties": {
          "last_seen": {
            "type": "string",
            "format": "date-time"
          },
          "subscriptions": {
            "type": "array",
            "schema": "$ref '#/components/schema/Subscription'",
            "items": {
              "allOf": [
                {
                  "$ref": "#/components/schemas/Subscription"
                }
              ]
            }
          },
          "geo_point_location": {
            "type": "array",
            "items": {
              "type": "number",
              "format": "float",
              "examples": [
                [
                  42.34,
                  83.04
                ]
              ]
            }
          },
          "city": {
            "type": "string",
            "examples": [
              "Kansas City"
            ]
          },
          "continent_code": {
            "type": "string",
            "examples": [
              "NA"
            ]
          },
          "country_code": {
            "type": "string",
            "examples": [
              "US"
            ]
          },
          "postal_code": {
            "type": "string",
            "examples": [
              64118
            ]
          },
          "province": {
            "type": "string",
            "examples": [
              "Missouri"
            ]
          },
          "time_zone": {
            "type": "string",
            "examples": [
              "America/Chicago"
            ]
          },
          "language": {
            "type": "string",
            "examples": [
              "en-us"
            ]
          },
          "operating_system": {
            "type": "string",
            "examples": [
              "Windows"
            ]
          },
          "operating_system_version": {
            "type": "string",
            "examples": [
              "10.11.14"
            ]
          },
          "device_type": {
            "type": "string",
            "examples": [
              "desktop"
            ]
          },
          "device_vendor": {
            "type": "string",
            "examples": [
              "Dell"
            ]
          },
          "browser": {
            "type": "string",
            "examples": [
              "Chrome"
            ]
          },
          "browser_version": {
            "type": "string",
            "examples": [
              "136.0.0"
            ]
          },
          "app_version": {
            "type": "string",
            "examples": [
              "1.2.3"
            ]
          }
        }
      },
      "Subscription": {
        "type": "object",
        "properties": {
          "channel": {
            "type": "string",
            "enum": [
              "APNS FCM WEB IAM"
            ],
            "examples": [
              "APNS"
            ]
          },
          "subscribed": {
            "type": "boolean"
          },
          "token": {
            "type": "string",
            "examples": [
              "0eb47496-545f-4feb-9461-bf135facf8b3"
            ]
          },
          "app_identifier": {
            "type": "string",
            "examples": [
              "com.Pushly.ExampleApplication"
            ]
          },
          "subscribed_date": {
            "type": "string",
            "format": "date-time"
          },
          "unsubscribe_date": {
            "type": "string",
            "format": "date-time"
          },
          "unsubscribe_reason": {
            "type": "string",
            "examples": [
              "Soft Unsubscribe Requested by User"
            ]
          }
        }
      }
    },
    "securitySchemes": {
      "apiKeyAuth": {
        "type": "apiKey",
        "in": "header",
        "name": "X-API-KEY"
      }
    }
  },
  "security": [
    {
      "apiKeyAuth": []
    }
  ],
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```