List users

get/v1/users/list

This API allows you to get a list of users with access to the specified account. If a search query is added to this API, you will get a response based on the search keyword.

Code snippet

curl -X 'GET' \
  'https://api.boldsign.com/v1/users/list?PageSize=10&Page=1&Search=xxxx' \
  -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("https://api.boldsign.com", "apikey");
var userClient = new UserClient(apiClient);
var result = await userClient.ListUsersAsync(1,10).ConfigureAwait(false);

import boldsign

configuration = boldsign.Configuration(
    api_key = "YOUR_API_KEY"
)

with boldsign.ApiClient(configuration) as api_client:
    
    user_api = boldsign.UserApi(api_client)
    
    user_list_response = user_api.list_users(
        page_size=10, page=1
    )

const axios = require('axios');

const response = await axios.get('https://api.boldsign.com/v1/users/list', {
  params: {
    PageSize: '10',
    Page: '1',
    Search: 'xxxx',
  },
  headers: {
    accept: 'application/json',
    'X-API-KEY': '{your API key}',
  },
});

Request body

PageSizeinteger	The number of results returned per page. The value must be between 1 and 100. The default value is `10.`
PageintegerRequired	Returns the page number of the user page.
Searchstring	Returns users from the search results based on a keyword.

Example response

200 Success

{
  "pageDetails": {
    "pageSize": 10,
    "page": 1
  },
  "result": [
    {
      "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"
      }
    }
  ]
}