GET api/users/{guid}/matches?page={page}&pageSize={pageSize}

Get all the matches for a single user

Request Information

URI Parameters

NameDescriptionTypeAdditional information
guid

globally unique identifier

Required

page

integer

Default value is 1

pageSize

integer

Default value is 25

Body Parameters

None.

Response Information

Resource Description

Get all the matches for a single user

Collection of ObitMatchGroupDto
NameDescriptionTypeAdditional information
Date

The date the notification for these matches was sent in yyyy-MM-dd format

date

None.

Matches

An enumeration of matches

Collection of ObitMatchDto

None.

GroupMatches

The group matches

Collection of ObitGroupMatchDto

None.

OrganizationMatches

The organization matches

Collection of ObitOrganizationMatchDto

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "date": "2025-12-14",
    "matches": [
      {
        "score": 1.1,
        "id": 0,
        "deceasedFirstName": "sample string 2",
        "deceasedLastName": "sample string 3",
        "deceasedWebsite": "sample string 4",
        "noteSentDate": "2025-12-14",
        "noteRead": true
      },
      {
        "score": 1.1,
        "id": 0,
        "deceasedFirstName": "sample string 2",
        "deceasedLastName": "sample string 3",
        "deceasedWebsite": "sample string 4",
        "noteSentDate": "2025-12-14",
        "noteRead": true
      }
    ],
    "groupMatches": [
      {
        "groupValue": "sample string 1",
        "id": 0,
        "deceasedFirstName": "sample string 2",
        "deceasedLastName": "sample string 3",
        "deceasedWebsite": "sample string 4",
        "noteSentDate": "2025-12-14",
        "noteRead": true
      },
      {
        "groupValue": "sample string 1",
        "id": 0,
        "deceasedFirstName": "sample string 2",
        "deceasedLastName": "sample string 3",
        "deceasedWebsite": "sample string 4",
        "noteSentDate": "2025-12-14",
        "noteRead": true
      }
    ],
    "organizationMatches": [
      {
        "organization": "sample string 1",
        "id": 0,
        "deceasedFirstName": "sample string 2",
        "deceasedLastName": "sample string 3",
        "deceasedWebsite": "sample string 4",
        "noteSentDate": "2025-12-14",
        "noteRead": true
      },
      {
        "organization": "sample string 1",
        "id": 0,
        "deceasedFirstName": "sample string 2",
        "deceasedLastName": "sample string 3",
        "deceasedWebsite": "sample string 4",
        "noteSentDate": "2025-12-14",
        "noteRead": true
      }
    ]
  },
  {
    "date": "2025-12-14",
    "matches": [
      {
        "score": 1.1,
        "id": 0,
        "deceasedFirstName": "sample string 2",
        "deceasedLastName": "sample string 3",
        "deceasedWebsite": "sample string 4",
        "noteSentDate": "2025-12-14",
        "noteRead": true
      },
      {
        "score": 1.1,
        "id": 0,
        "deceasedFirstName": "sample string 2",
        "deceasedLastName": "sample string 3",
        "deceasedWebsite": "sample string 4",
        "noteSentDate": "2025-12-14",
        "noteRead": true
      }
    ],
    "groupMatches": [
      {
        "groupValue": "sample string 1",
        "id": 0,
        "deceasedFirstName": "sample string 2",
        "deceasedLastName": "sample string 3",
        "deceasedWebsite": "sample string 4",
        "noteSentDate": "2025-12-14",
        "noteRead": true
      },
      {
        "groupValue": "sample string 1",
        "id": 0,
        "deceasedFirstName": "sample string 2",
        "deceasedLastName": "sample string 3",
        "deceasedWebsite": "sample string 4",
        "noteSentDate": "2025-12-14",
        "noteRead": true
      }
    ],
    "organizationMatches": [
      {
        "organization": "sample string 1",
        "id": 0,
        "deceasedFirstName": "sample string 2",
        "deceasedLastName": "sample string 3",
        "deceasedWebsite": "sample string 4",
        "noteSentDate": "2025-12-14",
        "noteRead": true
      },
      {
        "organization": "sample string 1",
        "id": 0,
        "deceasedFirstName": "sample string 2",
        "deceasedLastName": "sample string 3",
        "deceasedWebsite": "sample string 4",
        "noteSentDate": "2025-12-14",
        "noteRead": true
      }
    ]
  }
]

Error responses

No documented error responses