GET api/v2/Users/UserCards?EmailAddress={EmailAddress}&IncludeDeleted={IncludeDeleted}&FacilityCode={FacilityCode}

Returns list of cards for a given user by the User Email Address

Request Information

URI Parameters

Name	Type	Additional information
EmailAddress	string	Required
IncludeDeleted	boolean	Default value is False
FacilityCode	integer	Default value is -1

Body Parameters

None.

Response Information

Resource Description

PersonCardAndUserIdViewModelV2

Name	Description	Type	Additional information
UserId		globally unique identifier	None.
Cards		Collection of PersonCardViewModelV2	None.

Response Formats

application/json, text/json

Sample:

{
  "UserId": "97ff5987-dde2-438d-9fd6-6f765a7ca6b0",
  "Cards": [
    {
      "NumberOfCardUses": 1,
      "PublicNotes": "sample string 1",
      "PersonCardId": "33ef0d73-e058-4b56-9608-b6e6229a6141",
      "CardName": "sample string 3",
      "CardId": "a2989f13-fe56-4bbd-b6da-60f5b95701f3",
      "CardType": 5,
      "CardACSystemId": "75223b66-303c-4eae-9a17-7ffb2e06377e",
      "CardACSystemName": "sample string 7",
      "InternalCardNumber": 8,
      "ExternalCardNumber": "sample string 9",
      "CardSerialNumber": 1,
      "FacilityCode": 10,
      "IssueCode": 11,
      "PIN": "sample string 12",
      "Deleted": true,
      "HidInvitationCode": "sample string 14",
      "InvitationRedeemedDateTime": "2025-11-14T11:28:49.0042867+00:00",
      "DateInserted": "2025-11-14T11:28:49.0042867+00:00",
      "DateUpdated": "2025-11-14T11:28:49.0042867+00:00",
      "CardActivationStartDateTime": "2025-11-14T11:28:49.0042867+00:00",
      "CardDeactivationStartDateTime": "2025-11-14T11:28:49.0042867+00:00",
      "CardUserFlags": 1,
      "EncryptedMobileCredentials": [
        {
          "MobileKeySetId": "5165cb0e-981e-4dea-be74-61d1bba985a1",
          "KeyIndex": 2,
          "EncryptedCredential": "sample string 3"
        },
        {
          "MobileKeySetId": "5165cb0e-981e-4dea-be74-61d1bba985a1",
          "KeyIndex": 2,
          "EncryptedCredential": "sample string 3"
        }
      ],
      "CredentialType": 1
    },
    {
      "NumberOfCardUses": 1,
      "PublicNotes": "sample string 1",
      "PersonCardId": "33ef0d73-e058-4b56-9608-b6e6229a6141",
      "CardName": "sample string 3",
      "CardId": "a2989f13-fe56-4bbd-b6da-60f5b95701f3",
      "CardType": 5,
      "CardACSystemId": "75223b66-303c-4eae-9a17-7ffb2e06377e",
      "CardACSystemName": "sample string 7",
      "InternalCardNumber": 8,
      "ExternalCardNumber": "sample string 9",
      "CardSerialNumber": 1,
      "FacilityCode": 10,
      "IssueCode": 11,
      "PIN": "sample string 12",
      "Deleted": true,
      "HidInvitationCode": "sample string 14",
      "InvitationRedeemedDateTime": "2025-11-14T11:28:49.0042867+00:00",
      "DateInserted": "2025-11-14T11:28:49.0042867+00:00",
      "DateUpdated": "2025-11-14T11:28:49.0042867+00:00",
      "CardActivationStartDateTime": "2025-11-14T11:28:49.0042867+00:00",
      "CardDeactivationStartDateTime": "2025-11-14T11:28:49.0042867+00:00",
      "CardUserFlags": 1,
      "EncryptedMobileCredentials": [
        {
          "MobileKeySetId": "5165cb0e-981e-4dea-be74-61d1bba985a1",
          "KeyIndex": 2,
          "EncryptedCredential": "sample string 3"
        },
        {
          "MobileKeySetId": "5165cb0e-981e-4dea-be74-61d1bba985a1",
          "KeyIndex": 2,
          "EncryptedCredential": "sample string 3"
        }
      ],
      "CredentialType": 1
    }
  ]
}

application/xml, text/xml

Sample:

<PersonCardAndUserIdViewModelV2 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIWebRole.Controllers">
  <Cards>
    <PersonCardViewModelV2>
      <CardACSystemId>75223b66-303c-4eae-9a17-7ffb2e06377e</CardACSystemId>
      <CardACSystemName>sample string 7</CardACSystemName>
      <CardActivationStartDateTime>2025-11-14T11:28:49.0042867+00:00</CardActivationStartDateTime>
      <CardDeactivationStartDateTime>2025-11-14T11:28:49.0042867+00:00</CardDeactivationStartDateTime>
      <CardId>a2989f13-fe56-4bbd-b6da-60f5b95701f3</CardId>
      <CardName>sample string 3</CardName>
      <CardSerialNumber>1</CardSerialNumber>
      <CardType>5</CardType>
      <CardUserFlags>ActiveCardholderRecord</CardUserFlags>
      <CredentialType>Proximity</CredentialType>
      <DateInserted>2025-11-14T11:28:49.0042867+00:00</DateInserted>
      <DateUpdated>2025-11-14T11:28:49.0042867+00:00</DateUpdated>
      <EncryptedMobileCredentials>
        <EncryptedCredentialData>
          <EncryptedCredential>sample string 3</EncryptedCredential>
          <KeyIndex>2</KeyIndex>
          <MobileKeySetId>5165cb0e-981e-4dea-be74-61d1bba985a1</MobileKeySetId>
        </EncryptedCredentialData>
        <EncryptedCredentialData>
          <EncryptedCredential>sample string 3</EncryptedCredential>
          <KeyIndex>2</KeyIndex>
          <MobileKeySetId>5165cb0e-981e-4dea-be74-61d1bba985a1</MobileKeySetId>
        </EncryptedCredentialData>
      </EncryptedMobileCredentials>
      <ExternalCardNumber>sample string 9</ExternalCardNumber>
      <FacilityCode>10</FacilityCode>
      <HidInvitationCode>sample string 14</HidInvitationCode>
      <InternalCardNumber>8</InternalCardNumber>
      <InvitationRedeemedDateTime>2025-11-14T11:28:49.0042867+00:00</InvitationRedeemedDateTime>
      <IssueCode>11</IssueCode>
      <PIN>sample string 12</PIN>
      <PersonCardId>33ef0d73-e058-4b56-9608-b6e6229a6141</PersonCardId>
      <NumberOfCardUses>1</NumberOfCardUses>
      <PublicNotes>sample string 1</PublicNotes>
    </PersonCardViewModelV2>
    <PersonCardViewModelV2>
      <CardACSystemId>75223b66-303c-4eae-9a17-7ffb2e06377e</CardACSystemId>
      <CardACSystemName>sample string 7</CardACSystemName>
      <CardActivationStartDateTime>2025-11-14T11:28:49.0042867+00:00</CardActivationStartDateTime>
      <CardDeactivationStartDateTime>2025-11-14T11:28:49.0042867+00:00</CardDeactivationStartDateTime>
      <CardId>a2989f13-fe56-4bbd-b6da-60f5b95701f3</CardId>
      <CardName>sample string 3</CardName>
      <CardSerialNumber>1</CardSerialNumber>
      <CardType>5</CardType>
      <CardUserFlags>ActiveCardholderRecord</CardUserFlags>
      <CredentialType>Proximity</CredentialType>
      <DateInserted>2025-11-14T11:28:49.0042867+00:00</DateInserted>
      <DateUpdated>2025-11-14T11:28:49.0042867+00:00</DateUpdated>
      <EncryptedMobileCredentials>
        <EncryptedCredentialData>
          <EncryptedCredential>sample string 3</EncryptedCredential>
          <KeyIndex>2</KeyIndex>
          <MobileKeySetId>5165cb0e-981e-4dea-be74-61d1bba985a1</MobileKeySetId>
        </EncryptedCredentialData>
        <EncryptedCredentialData>
          <EncryptedCredential>sample string 3</EncryptedCredential>
          <KeyIndex>2</KeyIndex>
          <MobileKeySetId>5165cb0e-981e-4dea-be74-61d1bba985a1</MobileKeySetId>
        </EncryptedCredentialData>
      </EncryptedMobileCredentials>
      <ExternalCardNumber>sample string 9</ExternalCardNumber>
      <FacilityCode>10</FacilityCode>
      <HidInvitationCode>sample string 14</HidInvitationCode>
      <InternalCardNumber>8</InternalCardNumber>
      <InvitationRedeemedDateTime>2025-11-14T11:28:49.0042867+00:00</InvitationRedeemedDateTime>
      <IssueCode>11</IssueCode>
      <PIN>sample string 12</PIN>
      <PersonCardId>33ef0d73-e058-4b56-9608-b6e6229a6141</PersonCardId>
      <NumberOfCardUses>1</NumberOfCardUses>
      <PublicNotes>sample string 1</PublicNotes>
    </PersonCardViewModelV2>
  </Cards>
  <UserId>97ff5987-dde2-438d-9fd6-6f765a7ca6b0</UserId>
</PersonCardAndUserIdViewModelV2>