Get user


This API allows you to get user details based on the userId you specified in the query parameter. It will fetch a response even if the user has not yet accepted the invite from BoldSign.

Code snippet

curl -X 'GET' \
  '' \
  -H 'accept: application/json' \
  -H 'X-API-KEY: {your API key}' \
// accessing metadata property requires beta version of the SDK at least v4.10.18-beta
var apiClient = new ApiClient("", "{apikey}");
var userClient = new UserClient(apiClient);
var userDetails = await userClient.GetUserDetailsAsync("e892ea92-xxxx-xxxx-xxxx-bbdbcaa5xxxx").ConfigureAwait(false);
import requests

url = ""

headers = {
  'accept': 'application/json',
  'X-API-KEY': '{your API key}'

response = requests.request("GET", url, headers=headers, data=payload)

const axios = require('axios');

const response = await axios.get('', {
  params: {
    userId: 'e892ea92-xxxx-xxxx-xxxx-bbdbcaa5xxxx',
  headers: {
    accept: 'application/json',
    'X-API-KEY': '{your API key}',

Request body

userIdstringRequiredThe ID of the user account.

Example response

200 Success

  "userId": "e892ea92-xxxx-xxxx-xxxx-bbdbcaa5xxxx",
  "email": "",
  "firstName": "luther",
  "lastName": "cooper",
  "teamId": "xxc5b097-xxxx-xxxx-xxxx-afd07c66xxxx",
  "teamName": "Default",
  "role": "Member",
  "userStatus": "Active",
  "createdDate": 1646824225,
  "modifiedDate": 1647323111,
  "metaData": {
    "Employee": "Permanent",
    "Department": "Sales",
    "Designation": "Sales Manager"