Personyze Support Personyze Support docs
Open Personyze
Setup

Developer Resources — REST API & SDKs

REST API for managing your Personyze account programmatically, plus SDKs for Android, iOS, and Google Tag Manager. Read the full reference, browse the GitHub repos, and start integrating.

Updated 1 hour ago 3 min read
A
by Admin

Personyze offers a REST API for managing your account programmatically and a set of SDKs for native mobile and tag-manager integration. This page is the starting point — quick overviews plus links out to the full reference documentation and source code.

REST API

The Personyze REST API lets third-party applications read and modify data in your account: add or delete placeholders, manage your product catalog, work with user lists, perform operations on online or offline users, and more. It uses standard HTTP, accepts and returns JSON, and supports the four standard verbs (GET, POST, PUT, DELETE).

Quick example

List all placeholders in your account using curl:

curl 'https://api:YOUR_API_KEY@app.personyze.com/rest/placeholders'

Replace YOUR_API_KEY with your account’s API key. Returns a JSON array. Add a new placeholder with POST, modify with PUT, delete with DELETE — same URL pattern.

Available objects

The API works object-wise. Each object has its own endpoint and reference page in the full docs:

doPerform operations on currently-online users — fire goals, set attributes, deliver content programmatically.
usersManage offline users (records that exist in your CRM or DB but haven’t visited the site yet).
user_lists / user_list_usersCreate and manage user lists, and the associations between users and lists.
placeholdersList, create, modify, or delete the placeholders that anchor personalization on your site.
actionsRead and update Personyze actions (popups, banners, content swaps, etc.) programmatically.
products / products_feedRead and write your product catalog, or trigger a feed re-sync.
articlesSame as products but for content/articles — for content recommendation use cases.
product_interactions / article_interactionsRead or write interaction events (views, add-to-cart, purchases) for products and articles.
containers_grab_variableManage the rules that scrape attributes from your site’s DOM into visitor profile fields.

Full reference documentation

Each object has its own deep-reference page covering all parameters, request examples, and response shapes:

→ Full REST API reference (request format, response codes, object pages, advanced path parameter syntax)

Authentication.The API uses HTTP Basic Auth. Username is always api; password is your account’s API key. Requests must use HTTPS — non-HTTPS requests get 401 Unauthorized.

Common limits and behaviors

  • Up to 1,000 records per request. Use /limit/1000 as the maximum page size.
  • Indexed vs. non-indexed lookups. Selecting users by email is fast (indexed); selecting by first name or arbitrary attribute is slow (full scan) and rate-limited.
  • Status codes. 200 success · 401 bad key or non-HTTPS · 500 error (with description in body) · 503 temporarily unavailable, retry after the indicated number of seconds.

SDKs & tooling on GitHub

All Personyze open-source code lives at github.com/personyze. Six repositories cover the major integration surfaces:

Native mobile SDKs

📱 Android SDK (Java)Full Personyze tracking and personalization for Android apps. Repo → · Demo app →
🍎 iOS SDK (Swift)Native iOS integration with the same feature set as the Android SDK. Repo → · Demo app →

Both SDKs are published under MIT license. The demo apps are runnable references showing the full setup-to-personalization flow.

For a guided walkthrough on integrating the mobile SDKs with the rest of Personyze (catalog setup, recommendation widgets, etc.) see Mobile App Product Recommendations Integration Guide.

Web tooling

🏷 Google Tag Manager templatePersonyze tracking code packaged as an importable GTM template. Drop into your container instead of hand-coding the snippet. Repo →
📝 Personyze template languageReference for the templating syntax used in action source HTML — variables, loops, conditionals, escapes. Useful when authoring or debugging custom action templates. Repo →

Pair the GTM template with the Google Tag Manager setup guide for the full integration flow.