GET api/v1/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

NameDescriptionTypeAdditional information
EmailAddress

string

Required
IncludeDeleted

boolean

Default value is False
FacilityCode

integer

Default value is -1

Body Parameters

None.

Response Information

Resource Description

PersonCardAndUserIdViewModel
NameDescriptionTypeAdditional information
UserId

globally unique identifier

None.
Cards

Collection of PersonCardViewModel

None.

Response Formats

application/json, text/json

Sample: 
{
  "UserId": "dc37ec9c-33cc-4b74-9a46-b067f1ba22b8",
  "Cards": [
    {
      "PersonCardId": "4a8a66ac-8893-4b31-8837-853ff50c82d8",
      "CardName": "sample string 2",
      "CardId": "471b5562-63a1-4177-9851-27a1b603f5b5",
      "CardType": 4,
      "CardACSystemId": "cb76f875-e8f1-4f27-9d5c-93e5ab578879",
      "CardACSystemName": "sample string 6",
      "InternalCardNumber": 7,
      "ExternalCardNumber": "sample string 8",
      "CardSerialNumber": 1,
      "FacilityCode": 9,
      "IssueCode": 10,
      "PIN": "sample string 11",
      "Deleted": true,
      "HidInvitationCode": "sample string 13",
      "InvitationRedeemedDateTime": "2025-10-12T03:52:51.9644259+00:00",
      "DateInserted": "2025-10-12T03:52:51.9644259+00:00",
      "DateUpdated": "2025-10-12T03:52:51.9644259+00:00",
      "CardActivationStartDateTime": "2025-10-12T03:52:51.9644259+00:00",
      "CardDeactivationStartDateTime": "2025-10-12T03:52:51.9644259+00:00",
      "CardUserFlags": 1,
      "EncryptedMobileCredentials": [
        {
          "MobileKeySetId": "9edf5b73-c00d-4b84-bf58-26f75e25ff3f",
          "KeyIndex": 2,
          "EncryptedCredential": "sample string 3"
        },
        {
          "MobileKeySetId": "9edf5b73-c00d-4b84-bf58-26f75e25ff3f",
          "KeyIndex": 2,
          "EncryptedCredential": "sample string 3"
        }
      ],
      "CredentialType": 1
    },
    {
      "PersonCardId": "4a8a66ac-8893-4b31-8837-853ff50c82d8",
      "CardName": "sample string 2",
      "CardId": "471b5562-63a1-4177-9851-27a1b603f5b5",
      "CardType": 4,
      "CardACSystemId": "cb76f875-e8f1-4f27-9d5c-93e5ab578879",
      "CardACSystemName": "sample string 6",
      "InternalCardNumber": 7,
      "ExternalCardNumber": "sample string 8",
      "CardSerialNumber": 1,
      "FacilityCode": 9,
      "IssueCode": 10,
      "PIN": "sample string 11",
      "Deleted": true,
      "HidInvitationCode": "sample string 13",
      "InvitationRedeemedDateTime": "2025-10-12T03:52:51.9644259+00:00",
      "DateInserted": "2025-10-12T03:52:51.9644259+00:00",
      "DateUpdated": "2025-10-12T03:52:51.9644259+00:00",
      "CardActivationStartDateTime": "2025-10-12T03:52:51.9644259+00:00",
      "CardDeactivationStartDateTime": "2025-10-12T03:52:51.9644259+00:00",
      "CardUserFlags": 1,
      "EncryptedMobileCredentials": [
        {
          "MobileKeySetId": "9edf5b73-c00d-4b84-bf58-26f75e25ff3f",
          "KeyIndex": 2,
          "EncryptedCredential": "sample string 3"
        },
        {
          "MobileKeySetId": "9edf5b73-c00d-4b84-bf58-26f75e25ff3f",
          "KeyIndex": 2,
          "EncryptedCredential": "sample string 3"
        }
      ],
      "CredentialType": 1
    }
  ]
}

application/xml, text/xml

Sample: 
<PersonCardAndUserIdViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIWebRole.Controllers">
  <Cards>
    <PersonCardViewModel>
      <CardACSystemId>cb76f875-e8f1-4f27-9d5c-93e5ab578879</CardACSystemId>
      <CardACSystemName>sample string 6</CardACSystemName>
      <CardActivationStartDateTime>2025-10-12T03:52:51.9644259+00:00</CardActivationStartDateTime>
      <CardDeactivationStartDateTime>2025-10-12T03:52:51.9644259+00:00</CardDeactivationStartDateTime>
      <CardId>471b5562-63a1-4177-9851-27a1b603f5b5</CardId>
      <CardName>sample string 2</CardName>
      <CardSerialNumber>1</CardSerialNumber>
      <CardType>4</CardType>
      <CardUserFlags>ActiveCardholderRecord</CardUserFlags>
      <CredentialType>Proximity</CredentialType>
      <DateInserted>2025-10-12T03:52:51.9644259+00:00</DateInserted>
      <DateUpdated>2025-10-12T03:52:51.9644259+00:00</DateUpdated>
      <EncryptedMobileCredentials>
        <EncryptedCredentialData>
          <EncryptedCredential>sample string 3</EncryptedCredential>
          <KeyIndex>2</KeyIndex>
          <MobileKeySetId>9edf5b73-c00d-4b84-bf58-26f75e25ff3f</MobileKeySetId>
        </EncryptedCredentialData>
        <EncryptedCredentialData>
          <EncryptedCredential>sample string 3</EncryptedCredential>
          <KeyIndex>2</KeyIndex>
          <MobileKeySetId>9edf5b73-c00d-4b84-bf58-26f75e25ff3f</MobileKeySetId>
        </EncryptedCredentialData>
      </EncryptedMobileCredentials>
      <ExternalCardNumber>sample string 8</ExternalCardNumber>
      <FacilityCode>9</FacilityCode>
      <HidInvitationCode>sample string 13</HidInvitationCode>
      <InternalCardNumber>7</InternalCardNumber>
      <InvitationRedeemedDateTime>2025-10-12T03:52:51.9644259+00:00</InvitationRedeemedDateTime>
      <IssueCode>10</IssueCode>
      <PIN>sample string 11</PIN>
      <PersonCardId>4a8a66ac-8893-4b31-8837-853ff50c82d8</PersonCardId>
    </PersonCardViewModel>
    <PersonCardViewModel>
      <CardACSystemId>cb76f875-e8f1-4f27-9d5c-93e5ab578879</CardACSystemId>
      <CardACSystemName>sample string 6</CardACSystemName>
      <CardActivationStartDateTime>2025-10-12T03:52:51.9644259+00:00</CardActivationStartDateTime>
      <CardDeactivationStartDateTime>2025-10-12T03:52:51.9644259+00:00</CardDeactivationStartDateTime>
      <CardId>471b5562-63a1-4177-9851-27a1b603f5b5</CardId>
      <CardName>sample string 2</CardName>
      <CardSerialNumber>1</CardSerialNumber>
      <CardType>4</CardType>
      <CardUserFlags>ActiveCardholderRecord</CardUserFlags>
      <CredentialType>Proximity</CredentialType>
      <DateInserted>2025-10-12T03:52:51.9644259+00:00</DateInserted>
      <DateUpdated>2025-10-12T03:52:51.9644259+00:00</DateUpdated>
      <EncryptedMobileCredentials>
        <EncryptedCredentialData>
          <EncryptedCredential>sample string 3</EncryptedCredential>
          <KeyIndex>2</KeyIndex>
          <MobileKeySetId>9edf5b73-c00d-4b84-bf58-26f75e25ff3f</MobileKeySetId>
        </EncryptedCredentialData>
        <EncryptedCredentialData>
          <EncryptedCredential>sample string 3</EncryptedCredential>
          <KeyIndex>2</KeyIndex>
          <MobileKeySetId>9edf5b73-c00d-4b84-bf58-26f75e25ff3f</MobileKeySetId>
        </EncryptedCredentialData>
      </EncryptedMobileCredentials>
      <ExternalCardNumber>sample string 8</ExternalCardNumber>
      <FacilityCode>9</FacilityCode>
      <HidInvitationCode>sample string 13</HidInvitationCode>
      <InternalCardNumber>7</InternalCardNumber>
      <InvitationRedeemedDateTime>2025-10-12T03:52:51.9644259+00:00</InvitationRedeemedDateTime>
      <IssueCode>10</IssueCode>
      <PIN>sample string 11</PIN>
      <PersonCardId>4a8a66ac-8893-4b31-8837-853ff50c82d8</PersonCardId>
    </PersonCardViewModel>
  </Cards>
  <UserId>dc37ec9c-33cc-4b74-9a46-b067f1ba22b8</UserId>
</PersonCardAndUserIdViewModel>