# Get clients

**GET /api/v2/clients**

This endpoint retrieves a list of clients that the user has permission to access, which can be filtered by various parameters. The response data will be an array of objects with each object being the data for one client.


## Servers
- https://api.fincalc.co.uk: https://api.fincalc.co.uk ()


## Authentication methods
- Bearer auth


## Parameters


### Query parameters
- **PageNumber** (integer)
  Specifies the page number of results to retrieve.
- **PageSize** (integer)
  Specifies the number of results per page.
- **FirstName** (string)
  Filter clients by first name.
- **Surname** (string)
  Filter clients by surname.
- **NINumber** (string)
  Filter clients by National Insurance Number.
- **ClientReference** (string)
  Filter clients by client reference.
- **Postcode** (string)
  Filter clients by postcode.
- **ClientTags** (string)
  Filter clients by tags. This should be the GUID of the client or system supplied tag you wish to search by. If you wish to search by multiple tags, the list of GUIDS MUST be separated by a comma.
- **ExcludeFormattedValues** (string)
  If set to any value, formatted values will be excluded from the response.


## Responses
### 200
Success

#### Body: application/json (object)
- **success** (boolean)

- **data** (array[object])

- **meta** (object)



[Powered by Bump.sh](https://bump.sh)