# Users API

> Current Froomle documentation · [View canonical page](https://docs.froomle.com/froomle-doc-main/v2/guide/topics/users-api.html)

> **WARNING:**
> 
> 🚧 This page is under construction. Content may be incomplete or subject to change.

The Users API exposes user‑level records used for personalization and analytics.

<a id="_when_to_use_it"></a>

## When to use it

Use the Users API if you need to inspect or validate user records, troubleshoot identity consistency, or integrate with downstream analytics systems.

<a id="_how_it_relates_to_identity_and_consent"></a>

## How it relates to identity and consent

-   `user_id` and `device_id` are the only identifiers used.
    
-   PII must never be sent or stored in these identifiers.
    
-   No‑consent flows should avoid user‑level tracking events.
    

<a id="_related_topics"></a>

## Related topics

-   [User identity and consent](https://docs.froomle.com/froomle-doc-main/v2/guide/topics/user-identity-consent.html)