Sharetribe icon

Sharetribe

Allows interaction with the Sharetribe Integration API

User → Get

AI-generated

Summary

Fetch a user from Sharetribe by UUID or email, optionally returning a simplified response with selected fields.

Inputs

  • lookUpBy (required) — Method to look up the user ("id" or "email")
  • userId (required) — User's UUID
  • userEmail (required) — User's email address
  • simplify — Whether to return a simplified version of the response
  • userFields — Fields to return from the user record

Output shape

single user record

Returns a user object; if simplify is true only a default subset of fields is included, otherwise userFields determines the returned attributes; may be null if the user is not found.

Examples

Example 1: Get a user by UUID and return only email and state

lookUpBy: id, userId: 550e8400-e29b-41d4-a716-446655440000, userFields: ["email","state"], simplify: true

Example 2: Retrieve a user by email with default fields

lookUpBy: email, userEmail: user@example.com, simplify: true

Example 3: Fetch a user by ID and return a custom set of fields

lookUpBy: id, userId: 123, userFields: ["displayName","bio","createdAt"], simplify: false

Links

Discussion