Get user
get/v1/users/getThis 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' \ 'https://api.boldsign.com/v1/users/get?userId=e892ea92-xxxx-xxxx-xxxx-bbdbcaa5xxxx' \ -H 'accept: application/json' \ -H 'X-API-KEY: {your API key}' \
var apiClient = new ApiClient("YOUR_API_KEY"); var userClient = new UserClient(apiClient); var userDetails = userClient.GetUserDetails("YOUR_USER_ID");
import boldsign configuration = boldsign.Configuration(api_key="YOUR_API_KEY") with boldsign.ApiClient(configuration) as api_client: user_api = boldsign.UserApi(api_client) user_details = user_api.get_user(user_id="YOUR_USER_ID")
<?php require_once "vendor/autoload.php"; use BoldSign\Configuration; use BoldSign\Api\UserApi; $config = new Configuration(); $config->setApiKey('YOUR_API_KEY'); $user_api = new UserApi($config); $user_details = $user_api->getUser($user_id='YOUR_USER_ID');
ApiClient client = Configuration.getDefaultApiClient(); client.setApiKey("YOUR_API_KEY"); UserApi userApi = new UserApi(client); UserProperties userDetails = userApi.getUser("YOUR_USER_ID");
import { UserApi } from "boldsign"; const userApi = new UserApi(); userApi.setApiKey("YOUR_API_KEY"); const userDetails = userApi.getUser("YOUR_USER_ID");
Query parameters
userIdstringRequired | The ID of the user account. |
Example response
200 Success
{ "userId": "e892ea92-xxxx-xxxx-xxxx-bbdbcaa5xxxx", "email": "luthercooper@cubeflakes.com", "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" } }