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": "c79ab32e-8615-4d06-9b18-de7a98bdd6da",
  "Cards": [
    {
      "PersonCardId": "e3fc9ac3-3521-4d0b-8326-d26ff2fc7169",
      "CardName": "sample string 2",
      "CardId": "72fa7290-fa3c-4448-aa2a-f6336c99e2dd",
      "CardType": 4,
      "CardACSystemId": "0bfbb218-bf84-4484-8950-c4fcdc8cfce3",
      "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": "2026-02-28T09:08:34.1706987+00:00",
      "DateInserted": "2026-02-28T09:08:34.1706987+00:00",
      "DateUpdated": "2026-02-28T09:08:34.1706987+00:00",
      "CardActivationStartDateTime": "2026-02-28T09:08:34.1706987+00:00",
      "CardDeactivationStartDateTime": "2026-02-28T09:08:34.1706987+00:00",
      "CardUserFlags": 1,
      "EncryptedMobileCredentials": [
        {
          "MobileKeySetId": "999289d9-8155-4482-b91d-090f3ad81ed7",
          "KeyIndex": 2,
          "EncryptedCredential": "sample string 3"
        },
        {
          "MobileKeySetId": "999289d9-8155-4482-b91d-090f3ad81ed7",
          "KeyIndex": 2,
          "EncryptedCredential": "sample string 3"
        }
      ],
      "CredentialType": 1
    },
    {
      "PersonCardId": "e3fc9ac3-3521-4d0b-8326-d26ff2fc7169",
      "CardName": "sample string 2",
      "CardId": "72fa7290-fa3c-4448-aa2a-f6336c99e2dd",
      "CardType": 4,
      "CardACSystemId": "0bfbb218-bf84-4484-8950-c4fcdc8cfce3",
      "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": "2026-02-28T09:08:34.1706987+00:00",
      "DateInserted": "2026-02-28T09:08:34.1706987+00:00",
      "DateUpdated": "2026-02-28T09:08:34.1706987+00:00",
      "CardActivationStartDateTime": "2026-02-28T09:08:34.1706987+00:00",
      "CardDeactivationStartDateTime": "2026-02-28T09:08:34.1706987+00:00",
      "CardUserFlags": 1,
      "EncryptedMobileCredentials": [
        {
          "MobileKeySetId": "999289d9-8155-4482-b91d-090f3ad81ed7",
          "KeyIndex": 2,
          "EncryptedCredential": "sample string 3"
        },
        {
          "MobileKeySetId": "999289d9-8155-4482-b91d-090f3ad81ed7",
          "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>0bfbb218-bf84-4484-8950-c4fcdc8cfce3</CardACSystemId>
      <CardACSystemName>sample string 6</CardACSystemName>
      <CardActivationStartDateTime>2026-02-28T09:08:34.1706987+00:00</CardActivationStartDateTime>
      <CardDeactivationStartDateTime>2026-02-28T09:08:34.1706987+00:00</CardDeactivationStartDateTime>
      <CardId>72fa7290-fa3c-4448-aa2a-f6336c99e2dd</CardId>
      <CardName>sample string 2</CardName>
      <CardSerialNumber>1</CardSerialNumber>
      <CardType>4</CardType>
      <CardUserFlags>ActiveCardholderRecord</CardUserFlags>
      <CredentialType>Proximity</CredentialType>
      <DateInserted>2026-02-28T09:08:34.1706987+00:00</DateInserted>
      <DateUpdated>2026-02-28T09:08:34.1706987+00:00</DateUpdated>
      <EncryptedMobileCredentials>
        <EncryptedCredentialData>
          <EncryptedCredential>sample string 3</EncryptedCredential>
          <KeyIndex>2</KeyIndex>
          <MobileKeySetId>999289d9-8155-4482-b91d-090f3ad81ed7</MobileKeySetId>
        </EncryptedCredentialData>
        <EncryptedCredentialData>
          <EncryptedCredential>sample string 3</EncryptedCredential>
          <KeyIndex>2</KeyIndex>
          <MobileKeySetId>999289d9-8155-4482-b91d-090f3ad81ed7</MobileKeySetId>
        </EncryptedCredentialData>
      </EncryptedMobileCredentials>
      <ExternalCardNumber>sample string 8</ExternalCardNumber>
      <FacilityCode>9</FacilityCode>
      <HidInvitationCode>sample string 13</HidInvitationCode>
      <InternalCardNumber>7</InternalCardNumber>
      <InvitationRedeemedDateTime>2026-02-28T09:08:34.1706987+00:00</InvitationRedeemedDateTime>
      <IssueCode>10</IssueCode>
      <PIN>sample string 11</PIN>
      <PersonCardId>e3fc9ac3-3521-4d0b-8326-d26ff2fc7169</PersonCardId>
    </PersonCardViewModel>
    <PersonCardViewModel>
      <CardACSystemId>0bfbb218-bf84-4484-8950-c4fcdc8cfce3</CardACSystemId>
      <CardACSystemName>sample string 6</CardACSystemName>
      <CardActivationStartDateTime>2026-02-28T09:08:34.1706987+00:00</CardActivationStartDateTime>
      <CardDeactivationStartDateTime>2026-02-28T09:08:34.1706987+00:00</CardDeactivationStartDateTime>
      <CardId>72fa7290-fa3c-4448-aa2a-f6336c99e2dd</CardId>
      <CardName>sample string 2</CardName>
      <CardSerialNumber>1</CardSerialNumber>
      <CardType>4</CardType>
      <CardUserFlags>ActiveCardholderRecord</CardUserFlags>
      <CredentialType>Proximity</CredentialType>
      <DateInserted>2026-02-28T09:08:34.1706987+00:00</DateInserted>
      <DateUpdated>2026-02-28T09:08:34.1706987+00:00</DateUpdated>
      <EncryptedMobileCredentials>
        <EncryptedCredentialData>
          <EncryptedCredential>sample string 3</EncryptedCredential>
          <KeyIndex>2</KeyIndex>
          <MobileKeySetId>999289d9-8155-4482-b91d-090f3ad81ed7</MobileKeySetId>
        </EncryptedCredentialData>
        <EncryptedCredentialData>
          <EncryptedCredential>sample string 3</EncryptedCredential>
          <KeyIndex>2</KeyIndex>
          <MobileKeySetId>999289d9-8155-4482-b91d-090f3ad81ed7</MobileKeySetId>
        </EncryptedCredentialData>
      </EncryptedMobileCredentials>
      <ExternalCardNumber>sample string 8</ExternalCardNumber>
      <FacilityCode>9</FacilityCode>
      <HidInvitationCode>sample string 13</HidInvitationCode>
      <InternalCardNumber>7</InternalCardNumber>
      <InvitationRedeemedDateTime>2026-02-28T09:08:34.1706987+00:00</InvitationRedeemedDateTime>
      <IssueCode>10</IssueCode>
      <PIN>sample string 11</PIN>
      <PersonCardId>e3fc9ac3-3521-4d0b-8326-d26ff2fc7169</PersonCardId>
    </PersonCardViewModel>
  </Cards>
  <UserId>c79ab32e-8615-4d06-9b18-de7a98bdd6da</UserId>
</PersonCardAndUserIdViewModel>