Get user

GET 
/users/:user_id

note

This feature is only available in Preview to select customers on our Enterprise plan. Contact us for more information.

Returns a User object with the given id.

Request

Path Parameters

user_id stringrequired
Example: 0258cbc6-6020-430a-848e-aafacbadf4ae

Query Parameters

include_raw_data boolean
Whether to include raw data fetched from the 3rd party provider.
Example: true

Header Parameters

x-customer-id stringrequired
The customer ID that uniquely identifies the customer in your application
Example: my-customer-1
x-provider-name stringrequired
The provider name
Example: salesforce

Responses

200

UserData

application/json

Schema

Schema

name stringnullablerequired
email_address stringrequired
is_active booleanrequired
teams string[]
avatar stringnullable

Example (from schema)

{
  "name": "Hil Feig",
  "email_address": "help@supaglue.com",
  "is_active": false,
  "teams": [
    "681b0fd7-40e6-4b91-8e23-2814872090be"
  ],
  "avatar": "https://supaglue.io/user_profile_pic.png"
}

Loading...