get https://api.repsly.com/v3/export/clients/
Endpoint is used to export your clients 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 clients, start your request with parameter {lastTimeStamp} = 0.
Any planned changes to existing endpoints are marked with an orange diamond 🔸.
Response definition
Name | Type | Description |
---|---|---|
MetaCollectionResult\TotalCount | Integer | Total count of clients |
MetaCollectionResult\LastTimeStamp | Long | Timestamp of the latest client in the list |
ClientID | Integer | Unique client ID |
TimeStamp | Long | Client timestamp |
Code | String (50) | Unique client code |
Name | String (255) | Client name |
Active | Boolean | Marks a client active or inactive |
Tag | String | Tags associated with this client (separated with commas) |
Territory | Each territory in hierarchy: String (80) | The full territory hierarchy that this client is assigned to.The delimiter between territory levels is “>”(meaning that a territory in a two-level hierarchy is given as“ParentTerritory>ChildTerritory”) |
RepresentativeCode | String (20) | Unique representative code (assigned to thisclient) |
RepresentativeName | String (80) | Representative name (assigned to this client) |
StreetAddress | String (255) | Client street address |
ZIP | String (20) | Client ZIP code |
ZIPExt | String (20) | Client ZIP extension |
City | String (255) | Client city |
State | String (255) | Client state |
Country | String (255) | Client country |
String (255) | Client email address | |
Phone | String (128) | Client phone number |
Mobile | String (128) | Client mobile phone number |
Website | String (255) | Client website |
ContactName | String (255) | Contact person name |
ContactTitle | String (50) | Contact person title |
Note | String (255) | Additional client note |
Status | Text | Client status name in sales cycle |
CustomFields\Item\Field | String (255) | Custom field name |
CustomFields\Item\Value | Text | Custom field value |
PriceLists\Name | Text | List of price list names connected to this client |
AccountCode | Text | Code of the account assigned to this client. |