Get clients

GET /api/v2/clients
Bearer auth

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.

Query parameters

  • PageNumber integer

    Specifies the page number of results to retrieve.

    Minimum value is 1. Default value is 1.

  • PageSize integer

    Specifies the number of results per page.

    Minimum value is 1, maximum value is 100. Default value is 100.

  • 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 application/json

    Success

    Hide response attributes Show response attributes object
    • success boolean

      Default value is true.

    • data array[object]
      Hide data attributes Show data attributes object
      • ClientGUID string(uuid)
      • FirstName string
      • Surname string
      • Gender integer

        Values are 1, 2, or 3.

      • DateOfBirth string(date)
      • AddressPostCode string
      • Reference string
      • AdviserUserGUID string(uuid)
      • BackOfficeID string
      • FormattedValues object
    • meta object
      Hide meta attributes Show meta attributes object
      • CurrentPage integer
      • PageSize integer
      • HasPreviousPage boolean
      • HasNextPage boolean
      • Links object
        Hide Links attributes Show Links attributes object
        • PreviousPage string | null
        • NextPage string | null
GET /api/v2/clients 
curl \
 --request GET 'https://api.fincalc.co.uk/api/v2/clients' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "success": true,
  "data": [
    {
      "ClientGUID": "3F0B1C88-6D80-4C17-BB3E-1D68E6D26405",
      "FirstName": "John",
      "Surname": "Smith",
      "Gender": 1,
      "DateOfBirth": "1990-05-04",
      "AddressPostCode": "SW1A 1AA",
      "Reference": "API Client",
      "AdviserUserGUID": "string",
      "BackOfficeID": "3F0B1C88-6D80-4C17-BB3E-1D68E6D26405",
      "FormattedValues": {
        "Gender": "Male",
        "DateOfBirth": "04/05/1990",
        "AdviserUserGUID": "Jonathan Thomas"
      }
    }
  ],
  "meta": {
    "CurrentPage": 2,
    "PageSize": 5,
    "HasPreviousPage": true,
    "HasNextPage": true,
    "Links": {
      "PreviousPage": "https://api.fincalc.co.uk/api/v2/clients?PageSize=5&PageNumber=1",
      "NextPage": "https://api.fincalc.co.uk/api/v2/clients?PageSize=5&PageNumber=3"
    }
  }
}