UGC Techdocs
  • Introduction
  • Guides
    • Analytics
      • Tracking UGC on Adobe Analytics
      • Tracking Widget interactions with Google Analytics
    • Direct Uploader
      • How to add Custom Data to Direct Uploader
      • How to capture Custom Data on Direct Uploader
      • How to automatically tag data on Direct Uploader
      • How to Customize error messages on Direct Uploader
      • How to Track Direct Uploader form submissions with Google Analytics (Universal & GA 4)
    • Data Templates
      • Creating a Data Template
    • Rights via Registration
      • Capture Custom Data on Rights by Registration Form
      • Styling Rights via Registration Form
    • REST API
      • Caching REST API results for optimization
      • Posting content into Nosto via Tile API
      • Posting images into Nosto via Tile API
    • Onsite Widgets (2.0)
      • Blank Canvas
        • How to Use the Blank Canvas to Create a Twitter Count Widget
        • Creating an Auto-Scrolling Carousel using Blank Canvas
        • Creating Gallery Widget by Using the Blank Canvas Widget
        • Creating a simple Hover effect using Blank Canvas
        • Creating a Word Cloud using Blank Canvas
        • Creating Your Widget by Using the Blank Canvas
      • Bind your own Events
      • Creating a Grid Widget from Waterfall
      • Create a Q&A Widget using Data Templates
      • Displaying a Widget in a Mobile App
      • Dynamically Specify Products to Display in Widget
      • Dynamically specify what Tile to display in a Widget
      • How to add a title / subtitle to a widget
      • How to localize the load more button on widgets
      • How to overlay existing Google Map with the UGC Map Widget
      • Styling cross-sellers on Grid and Carousel Widgets
      • How to Load External JS and CSS into Widgets
      • Profiling Widget Performance
      • Re-targeting with Widgets and Facebook Pixel
      • Render Widget filters dynamically
      • Styling Carousel Widget
      • Styling Grid Widget
      • Styling Masonry Widget
      • Styling Waterfall Widget
      • Styling Widget Expanded Tile
      • Styling Widget Shopspots
      • Using Web Fonts in Widgets
    • Digital Screens
      • Customizing Carousel Event Screen
      • Customizing Mosaic Event Screen
      • Customizing Scrollwall Event Screen
      • Customizing the Mosaic Event Screen to Have 9 Even Tiles
    • Email
      • Adding Location to an Email Tile
      • Styling the Email Widget
    • Integrations
      • DoubleClick
        • UGC Ads with Nosto and Google DoubleClick
      • Zapier
        • Consuming UGC Webhooks via Zapier
      • Mailchimp
        • Bring Social Content into a Mailchimp Campaign
    • Webhooks
      • Trigger notifications when content is in the moderation queue
  • Widgets
  • API Docs
    • JavaScript API
      • Widgets
        • Introduction
        • API Reference for Content Widgets
        • API Reference for Blank Canvas
        • API Reference for Map Widget
      • Digital Screens
        • Introduction
        • API Reference
    • Content API
      • Reference
    • REST API
      • Reference
        • Filters API
        • Moderation Views API
        • Tags API
        • Terms API
        • Tiles API
        • Users API
        • Widgets API
        • Automation Rules API
        • REST API Reference Widgets style and config
      • Best Practices
    • Webhooks
  • Enterprise Tools
    • Automation Rules
      • Triggers
      • Actions
      • Samples
    • Data Templates
    • User Access Control (UAC)
    • Single Sign On (SSO)
    • Enterprise Admin User Interface (EAUI)
    • Zapier
  • Commerce Tools
    • Product Feeds
    • Widget Implementation
    • Reporting
    • Integrations
      • Google Tag Manager
      • Magento
      • SalesForce Commerce Cloud
      • Shopify
      • Shopify Add To Cart
        • Global Variant Mapping for Add to Cart
        • Customise Add to Cart Widget Experience
  • Analytics
    • Google Analytics 4
      • Getting Started
      • Widgets Events
      • E-commerce Events
      • Email Events
  • Terms of Use
Powered by GitBook
On this page
  • Users
  • Properties
  • GET users
  • GET users/:userId
  • PUT users/:userId
  • DELETE users/:userId

Was this helpful?

  1. API Docs
  2. REST API
  3. Reference

Users API

PreviousTiles APINextWidgets API

Was this helpful?

Users

Users are resources that have access to the Nosto admin portal. Users can't be created via API but are created by individuals following the invitation flow.

Properties

Field
Type
Value
PUT
Definition

id

integer

X

User Id

username

string

X

Username

name

string

✔

First name

surname

string

✔

Last name

email

string

✔

Email

description

string

✔

Notes on User

display_timezone

string

✔

Timezone used when displaying date time strings

distances

string

metric imperial

✔

Distance unit system to use when handling geo location distances

acl_groups

string or array

Admin = 1 Moderator = 2 Developer = 3

✔

A list of acl group ids, comma separated or JSON array when used in JSON body

last_login

datetime

X

User's last login datetime

created_at

timestamp

X

User's creation time

updated_at

timestamp

X

User's modification time

GET users

Retrieves all users available in the Stack.

Resource URL

https://api.stackla.com/api/users

Resource Details

Rate limited: Yes

Access scope: User

Request Parameters

Name
Mandatory
Request type
Description

page

No

query

Page number. Default value is 1

limit

No

query

Return limit define how many Users will be return for each request. Default is 25. Maximum limit is 100.

order_by

No

query

Return Users ordered by either id, name, email, surname, username, created. Sorts by id by default.

order_by_direction

No

query

Return ordered list of Users in either ascending (asc) or descending (desc) direction. Default is asc.

GET users/:userId

Retrieves a specific user available in the Stack by its ID.

Resource URL

https://api.stackla.com/api/users/:userId

Resource Details

Rate limited: Yes

Access scope: User

Request Parameters

Name
Mandatory
Request type
Description

userId

Yes

Request type

ID of the User

PUT users/:userId

Updates a specific user available in the Stack by its ID.

Resource URL

https://api.stackla.com/api/users/:userId

Resource Details

Rate limited: Yes

Access scope: User

Request Parameters

Name
Mandatory
Request type
Description

userId

Yes

endpoint

ID of the User

DELETE users/:userId

Deletes a specific user available in the Stack by its ID.

Resource URL

https://api.stackla.com/api/users/:userId

Resource Details

Rate limited: Yes

Access scope: User

Request Parameters

Name
Mandatory
Request type
Description

userId

Yes

endpoint

ID of the User

Properties
GET /api/users
GET /api/users/:userId
PUT /api/users/:userId
DELETE /api/users/:userId
Back to Top
Back to Top
Back to Top
Back to Top
Back to Top
tz database