Get All Clients API

Description

Get a list of all clients in the system

Security

Logged in user has client API permissions

URL

GET http://exampleserver.com/api/v6/clients?clientCode={clientCode}&clientName={clientName}&activeOnly={false}&groupCode={groupCode}

Parameters        

1. clientCode: [string, optional] search for client by code       
   
2. clientName: [string, optional] search for client by name
   
3. activeOnly: [optional] restrict list to active clients
   
4. groupCode: [optional] restrict list to clients within the group
   

Response

Client Response

Field	Type	Description
Clients	Array[ClientsOverviewDto]	A list of results if successful, null otherwise

ClientOverviewDto

Field	Type	Description
id	Integer	The client ID
code	String	The client code
active	Boolean	True if the client is active
clientDetailsLink	Link	URL for the client details

Example

{                                                                                                                                         

"id": 0,

"code": "string",

"active": true,

"clientDetailsLink": {

      "description": "string",

      "url": "string"

      }

} 

Error Codes

HTTP Status Code	Type
200	OK (Success)
204	No Content (no records match the search)
401	Unauthorised (not Authenticated)
403	Forbidden (invalid Authorisation)
503	Service Unavailable (due to maintenance)

Online Documentation

https://api.argos.co.nz/WebApi/swagger/ui/index#!/Clients

• Related Articles

• Get Client API

  Description Get details for a specific client Security Logged in user has client API permissions URL GET http://exampleserver.com/api/v6/clients/{clientId} Parameters clientId: [Required, part of URL] client to retrieve Response ClientDto Field Type ...

• Get Account Details API

  Description Retrieve the system specific details for an account Security Logged in user has account API permissions URL GET http://exampleserver.com/api/{system}/{accountId}?calculationDate=date Parameters system: [Required, part of URL] One of (case ...

• Create Client API

  Description Add a new client Security Logged in user has client API permissions URL POST http://example.com/api/clients/createClient Parameters TBC Response Create Client Request Field Type Description code String The client code name String The ...

• Update Client API

  Description Update the details of a specific client Security Logged in user has client API permissions URL PATCH http://exampleserver.com/api/v3/Clients/{client_id} Parameters Model Field Type Description actualAddress String (optional) The client's ...

• Get Account Transactions API

  Description Retrieve the transactions for an account Security Logged in user has account API permissions URL GET ...