Sign in

v1

latestOpenAPI 3.1.02026-07-2422707.0 MB

Retrieve the merge history of guest records

Use this API to fetch the merge history of guest records. This API also retrieves the history of guest records that have been merged across different centers.

You must specify appropriate details for the start_date and end_date parameters in the API request. Optionally, you can specify necessary details for the center_id, page, and size parameters in the API request.

get/v1/guests/merge_history?start_date={start_date}&end_date={end_date}&center_id={center_id}&page={page}&size={size}

Query parameters

start_datestring date required

Mandatory Date (in YYYY-MM-DD format) from which this API retrieves merge history of guest records. If you do not specify any particular time, the API considers the time as 00:00:00 by default. Note: You must ensure that the start_date value is lesser than the end_date value.

end_datestring date required

Mandatory Date (in YYYY-MM-DD format) before which this API retrieves merge history of guest records. If you do not specify any particular time, the API considers the time as 00:00:00 by default. Note: You must ensure that the end_date value is greater than the start_date value.

center_idstring

Optional Unique 32-character identifier of the center for which this API retrieves the Merged To guest records. If you do not specify any value for this parameter, the API retrieves the history of guest records that have been merged across different centers.

pageinteger

Optional Number of pages of merged guest records that is to be displayed. Default value of this parameter is 1.

sizeinteger

Optional Number of merged guest records that is to be displayed per page. Default value of this parameter is 10 and the maximum value is 100.

Response

200

OR

Example response

{
  "merge_history": [
    {
      "merged_date": "2013-07-03T18:03:46.817",
      "from_guest": {
        "id": "c65c4bf2-0b40-4269-805d-471a0690f0ac",
        "name": "Surya Teja",
        "center": {
          "id": "9a895b3c-1994-42c0-bc61-efda4a6e2828",
          "name": "Hyderabadd"
        }
      },
      "to_guest": {
        "id": "827dd637-9a6c-4ef2-a66f-62ce7b8464cd",
        "name": "Rajesh Tolety",
        "center": {
          "id": "9a895b3c-1994-42c0-bc61-efda4a6e2828",
          "name": "Hyderabadd"
        }
      }
    }
  ],
  "page_info": {
    "total": 4,
    "page": 1,
    "size": 10
  }
}