Page Comparison

Versions Compared

Key

Old Version 1

New Version 2

...

Endpoint ID:

1011

Method:

Status

colour	Green
title	POST

URL:

/user/search/{contract-id}

contract-id

Identifies the type of entities to search for and the contract fields to return. If omitted, all entity types are searched, each type returned using the default contract fields for that type.

Request body:

JSON data with search settings

Code Block

title	Example 1 – Search for “John Doe”:

{
	"searchFor": "John Doe"
}

Code Block

title	Example 2 – Search for “John Doe” with an offset of 40 and return no more than 20 entities:

{
	"searchFor": "John Doe",
	"offset": 40,
	"limit": 20
}

Response body:

Status codes:

Required fields

The string to search for in the database

Optional fields

The offset in search results from where to return data. If omitted, offset is set to zero

The maximum number of entities to return. It is not possible to return more than 50 entities per request, and if omitted, limit is set to 50