Gets a Case

The section below describes how to call the Search Case endpoint. If no search criteria is entered, the endpoint will retrieve the top 100 cases.

How to use

To call the endpoint you will need to perform a HTTP GET request to the URL:

Pagination options

There are two required pagination options that need to be provided in the query string.

• PageNumber
• PageSize

The page size is the number of results we wish to return per page. The page size has a range of 1-1000. The page number is the zero-based index of the page we wish to return.

Searchable field

• Type
• Forename
• Surname
• Client Reference
• Day of Birth
• Month of Birth
• Year of Birth
• Postcode
• Risk Group
• Email
• Tags

When searching using a risk group name, a full name must be given i.e. 'low' or 'high'. Risk group names are case-sensitive.

Example Search Response

The case(s) will be returned, if found.

{
    "count": 1,
    "caseSummarys": [
        {
            "id": "ce04915e-4baa-4b1a-a964-da90e1c6306f",
            "type":"Person",
            "forename": "John",
            "surname": "Preston",
            "dayOfBirth": 1,
            "monthOfBirth": 3,
            "yearOfBirth": 2010,
            "clientReference": "efg",
            "riskGroup": "low",
            "lastUpdatedDate": "2021-08-06T14:19:28.7628906Z",
            "email": "[email protected]",
            "tags": [
                "test"
            ]
        }
    ],
    "stats": {
        "totalCount": 3,
        "pageCount": 3
    }
}