get https://api.repsly.com/v3/export/users/
Endpoint is used to export your users from Repsly. System limit is 50 rows.
More Info
In every response you will receive meta variable LastTimeStamp of the last changed record in the list. Save it for future requests so you can use it as a parameter {lastTimeStamp} for every subsequent request until the response meta variable TotalCount is equal to 0, which means you have received all updates.
To get the complete list of users, start your request with parameter {lastTimeStamp} = 0.
Response definition
Name | Type | Description |
---|---|---|
MetaCollectionResult\TotalCount | Integer | Total count of users |
MetaCollectionResult\LastTimeStamp | long | Timestamp of the latest user in the list |
ID | Guid | Internal unique user identifier |
Code | String (20) | ID |
Name | String (80) | Name |
String (100) | ||
Active | Boolean | Is user active |
Role | String (80) | Roles, pipe separated (AccountOwner|Admin|Representative) |
Note | String (255) | Note |
Phone | String (128) | Phone |
Territories | Array(String) | The array of strings of territory paths that user is associated with. Territory path is representation of hierarchical territory position as territory names separated by “/”. Ex. “Territory 1/Territory 1.1/Territory 1.1.1” |
SendEmailEnabled | Boolean | User is allowed to send emails from mobile app |
Address1 | String (256) | Address Line 1 |
Address2 | String (256) | Address Line 2 |
City | String (256) | City |
State | String (256) | State |
ZipCode | String (20) | ZIP |
ZipCodeExt | String (20) | ZIP ext |
Country | String (256) | Country |
CountryCode | String (20) | Country code |
Attributes | Array(Attribute) | List of attributes with values and types specified for that company. |
Permissions | Arrray(String) | List of admin permissions |
Attribute
Name | Type | Description |
---|---|---|
Title | String | Name of the attribute (defined by the admin). |
Value | String | The value set for that user. If the value is null than the value is not set. |