Get clients
Get a list of the clients defined on your system.
sessionId in the response is your session token. Use this token in all the other calls that you make.
Also, make sure that you have the appropriate user type permissions to perform this API call. To view or update your permissions, in WorldServer, go to and then select your user type.
API call
Details
- GET method
- Content-Type in the header:
application/json - Mandatory parameter: the session token (as a query string parameter or as a key-value pair in the header)
Available filters
| Filter | Description |
|---|---|
| fields=<fieldName1,fieldName2,...,fieldNameN> | The names of the fields to be included in the JSON response, separated by commas. Do not use in conjunction with the excludedFields filter. |
| excludedFields=<fieldName1,fieldName2,…,fieldNameN> | The names of the fields to be excluded from the JSON response, separated by commas. Do not use in conjunction with the fields filter. |
| onlyMine=<true/false> | When true, returns only the clients in which the current user is included. |
- <protocol>://<ws-host>:<ws-port>/ws-api/v1/clients?token=<sessionId>&fields=id,name
- <protocol>://<ws-host>:<ws-port>/ws-api/v1/clients?token=<sessionId>&excludedFields=name&onlyMine=true
Advanced filtering
To reduce the amount of data in the result and to improve performance, you can perform the filtering deeper in the result tree structure. For example: <protocol>://<ws-host>:<ws-port>/ws-api/v1/clients?token=<sessionId>&fields=id,name,projectTypes(id,name,attributes(id,name))
- The ID, the name, and the project types of each client.
- The ID, the name, and the attributes of each project type.
- The ID and the name of each attribute.
Response
Error messages
No session token provided or invalid token (401 Unauthorized)