v1

latestOpenAPI 3.0.12026-07-245277551.2 MB
Merges

Returns a list of guest profile merges

get/merges

Query parameters

filterstring

Filter criteria in the format field:operation:value;field:operation:value.

  • field: The field name to filter on.
  • operation: The operation to apply (e.g., equals, not_equals, greater_than, less_than).
  • value: The value to filter by. Value is not required for some operations, like is_null. Multiple filters can be separated by semicolons (;).
pagenumber

Page number

perPagenumber

Results page size

includeTotalboolean
Example:true

Use true to get total in the response

Headers

X-Organization-Idstring required

Organization ID

Response

Response

offsetnumber

Offset of the total number of results

limitnumber

Results page size

totalnumber

Total number of results

Example response

{
  "data": [
    {
      "beforeMergeProfiles": [
        {
          "photoId": 12345,
          "taxId": "12345",
          "companyTaxId": "12345",
          "statusId": 12,
          "firstName": "John",
          "lastName": "Doe",
          "email": "john.doe@example.com",
          "phone": "123456789",
          "cellPhone": "123456789",
          "birthday": "1970-01-01",
          "gender": "M",
          "companyName": "Company",
          "address1": "Address line 1",
          "address2": "Address line 2",
          "city": "City",
          "country": "US",
          "countryName": "United States",
          "state": "State",
          "zip": "12345",
          "documentType": "driver_licence",
          "documentNumber": "123456789",
          "documentIssueDate": "1970-01-01",
          "documentIssuingCountry": "US",
          "documentExpirationDate": "1970-01-01",
          "id": "123456788",
          "organizationId": "12345",
          "statusName": "VIP",
          "statuses": [
            {
              "id": 1,
              "name": "VIP"
            },
            {
              "id": 2,
              "name": "Regular"
            }
          ],
          "dateCreated": "2024-08-06T13:38:35+00:00",
          "dateModified": "2024-08-06T16:58:59+00:00",
          "dateAnonymized": "2024-08-06T16:58:59+00:00",
          "parentId": "123456789",
          "photo": {
            "fileId": "12345",
            "path": "https://amazonaws.com/photo-jumbo~~67816f854de79.jpg",
            "croppedImage": "https://amazonaws.com/photo-jumbo_thumb~~67816f857ccab.jpg",
            "height": 797,
            "width": 1000,
            "cropParam": {
              "width": 75.140625,
              "height": 75.140625,
              "x": 212.12890625,
              "y": 210.203125
            }
          },
          "isAnonymizationAvailable": true
        }
      ],
      "afterMergeProfiles": [
        {
          "photoId": 12345,
          "taxId": "12345",
          "companyTaxId": "12345",
          "statusId": 12,
          "firstName": "John",
          "lastName": "Doe",
          "email": "john.doe@example.com",
          "phone": "123456789",
          "cellPhone": "123456789",
          "birthday": "1970-01-01",
          "gender": "M",
          "companyName": "Company",
          "address1": "Address line 1",
          "address2": "Address line 2",
          "city": "City",
          "country": "US",
          "countryName": "United States",
          "state": "State",
          "zip": "12345",
          "documentType": "driver_licence",
          "documentNumber": "123456789",
          "documentIssueDate": "1970-01-01",
          "documentIssuingCountry": "US",
          "documentExpirationDate": "1970-01-01",
          "id": "123456788",
          "organizationId": "12345",
          "statusName": "VIP",
          "statuses": [
            {
              "id": 1,
              "name": "VIP"
            },
            {
              "id": 2,
              "name": "Regular"
            }
          ],
          "dateCreated": "2024-08-06T13:38:35+00:00",
          "dateModified": "2024-08-06T16:58:59+00:00",
          "dateAnonymized": "2024-08-06T16:58:59+00:00",
          "parentId": "123456789",
          "photo": {
            "fileId": "12345",
            "path": "https://amazonaws.com/photo-jumbo~~67816f854de79.jpg",
            "croppedImage": "https://amazonaws.com/photo-jumbo_thumb~~67816f857ccab.jpg",
            "height": 797,
            "width": 1000,
            "cropParam": {
              "width": 75.140625,
              "height": 75.140625,
              "x": 212.12890625,
              "y": 210.203125
            }
          },
          "isAnonymizationAvailable": true
        }
      ]
    }
  ]
}