GET api/v1/candidates?properties={properties}&orderBy={orderBy}&take={take}&skip={skip}

Request Information

URI Parameters

Name	Type	Additional information
Suffix	string	None.
FirstName	string	None.
MiddleName	string	None.
LastName	string	None.
EmailAddress	string	None.
NewEmailAddress	string	None.
AddressLine1	string	None.
AddressLine2	string	None.
AddressLine3	string	None.
AddressLine4	string	None.
City	string	None.
StateProvince	string	None.
PostalCode	string	None.
Country	string	None.
PrimaryPhoneNumber	string	None.
PrimaryPhoneExtension	string	None.
SecondaryPhoneNumber	string	None.
SecondaryPhoneExtension	string	None.
FaxNumber	string	None.
BirthDate	date	None.
Values	Collection of ProfileValue	None.
Id	string	None.
PrometricId	string	None.
ClientCode	string	None.
ProgramCode	string	None.
ExamCode	string	None.
properties	string	None.
orderBy	string	None.
take	integer	Default value is 0
skip	integer	Default value is 0

Body Parameters

None.

Response Information

Resource Description

ResponseWrapperBindingModelOfIEnumerableOfProfileBindingModel

Name	Description	Type	Additional information
Results		Collection of ProfileBindingModel	None.
TotalResults		integer	None.

Response Formats

application/json, text/json

Sample:

{
  "TotalResults": 1,
  "Results": [
    {
      "Id": "sample string 1",
      "Href": "sample string 2",
      "Suffix": "sample string 3",
      "FirstName": "sample string 4",
      "MiddleName": "sample string 5",
      "LastName": "sample string 6",
      "EmailAddress": "sample string 7",
      "AddressLine1": "sample string 8",
      "AddressLine2": "sample string 9",
      "AddressLine3": "sample string 10",
      "AddressLine4": "sample string 11",
      "City": "sample string 12",
      "StateProvince": "sample string 13",
      "PostalCode": "sample string 14",
      "Country": "sample string 15",
      "PrimaryPhoneNumber": "sample string 16",
      "PrimaryPhoneExtension": "sample string 17",
      "SecondaryPhoneNumber": "sample string 18",
      "SecondaryPhoneExtension": "sample string 19",
      "FaxNumber": "sample string 20",
      "Username": "sample string 21",
      "SubscribeToEmails": true,
      "BirthDate": "2025-11-03T10:21:32.0491734-05:00",
      "PrometricId": "sample string 23",
      "Values": [
        {
          "Name": "sample string 1",
          "Value": "sample string 2"
        },
        {
          "Name": "sample string 1",
          "Value": "sample string 2"
        }
      ],
      "RequiresValidation": true,
      "ClientCode": "sample string 25",
      "ProgramCode": "sample string 26",
      "ExamCode": "sample string 27",
      "CreateLogin": "sample string 28",
      "NewEmailAddress": "sample string 29",
      "UniqueId": {
        "ProfileId": 1,
        "DemographicTemplateDetailName": "sample string 2",
        "UniqueId": "sample string 3",
        "DemographicTemplateDetail": {
          "DemographicId": 1,
          "IsRequired": true,
          "IsEditable": true,
          "IsVisible": true,
          "IsUnique": true,
          "IsCustom": true,
          "MaxLength": 1,
          "ValidRegEx": "sample string 7",
          "ValidationMask": "sample string 8",
          "DemographicDataTypeName": "sample string 9",
          "Ordinal": 10,
          "DisplayGroup": "sample string 11",
          "Name": "sample string 12",
          "DisplayName": {
            "DemographicId": 1,
            "Locale": "sample string 2",
            "DisplayText": "sample string 3"
          },
          "Options": [
            {
              "DemographicId": 1,
              "Value": "sample string 2",
              "Name": "sample string 3",
              "Ordinal": 4
            },
            {
              "DemographicId": 1,
              "Value": "sample string 2",
              "Name": "sample string 3",
              "Ordinal": 4
            }
          ],
          "ValidatorConfigurations": [
            {
              "DemographicId": 1,
              "Name": "sample string 2",
              "FullyQualifiedName": "sample string 3",
              "Ordinal": 4
            },
            {
              "DemographicId": 1,
              "Name": "sample string 2",
              "FullyQualifiedName": "sample string 3",
              "Ordinal": 4
            }
          ]
        },
        "Id": 4,
        "IsDeleted": true,
        "SavedByUser": "sample string 6",
        "SavedDateTime": "2025-11-03T10:21:32.0491734-05:00"
      }
    },
    {
      "Id": "sample string 1",
      "Href": "sample string 2",
      "Suffix": "sample string 3",
      "FirstName": "sample string 4",
      "MiddleName": "sample string 5",
      "LastName": "sample string 6",
      "EmailAddress": "sample string 7",
      "AddressLine1": "sample string 8",
      "AddressLine2": "sample string 9",
      "AddressLine3": "sample string 10",
      "AddressLine4": "sample string 11",
      "City": "sample string 12",
      "StateProvince": "sample string 13",
      "PostalCode": "sample string 14",
      "Country": "sample string 15",
      "PrimaryPhoneNumber": "sample string 16",
      "PrimaryPhoneExtension": "sample string 17",
      "SecondaryPhoneNumber": "sample string 18",
      "SecondaryPhoneExtension": "sample string 19",
      "FaxNumber": "sample string 20",
      "Username": "sample string 21",
      "SubscribeToEmails": true,
      "BirthDate": "2025-11-03T10:21:32.0491734-05:00",
      "PrometricId": "sample string 23",
      "Values": [
        {
          "Name": "sample string 1",
          "Value": "sample string 2"
        },
        {
          "Name": "sample string 1",
          "Value": "sample string 2"
        }
      ],
      "RequiresValidation": true,
      "ClientCode": "sample string 25",
      "ProgramCode": "sample string 26",
      "ExamCode": "sample string 27",
      "CreateLogin": "sample string 28",
      "NewEmailAddress": "sample string 29",
      "UniqueId": {
        "ProfileId": 1,
        "DemographicTemplateDetailName": "sample string 2",
        "UniqueId": "sample string 3",
        "DemographicTemplateDetail": {
          "DemographicId": 1,
          "IsRequired": true,
          "IsEditable": true,
          "IsVisible": true,
          "IsUnique": true,
          "IsCustom": true,
          "MaxLength": 1,
          "ValidRegEx": "sample string 7",
          "ValidationMask": "sample string 8",
          "DemographicDataTypeName": "sample string 9",
          "Ordinal": 10,
          "DisplayGroup": "sample string 11",
          "Name": "sample string 12",
          "DisplayName": {
            "DemographicId": 1,
            "Locale": "sample string 2",
            "DisplayText": "sample string 3"
          },
          "Options": [
            {
              "DemographicId": 1,
              "Value": "sample string 2",
              "Name": "sample string 3",
              "Ordinal": 4
            },
            {
              "DemographicId": 1,
              "Value": "sample string 2",
              "Name": "sample string 3",
              "Ordinal": 4
            }
          ],
          "ValidatorConfigurations": [
            {
              "DemographicId": 1,
              "Name": "sample string 2",
              "FullyQualifiedName": "sample string 3",
              "Ordinal": 4
            },
            {
              "DemographicId": 1,
              "Name": "sample string 2",
              "FullyQualifiedName": "sample string 3",
              "Ordinal": 4
            }
          ]
        },
        "Id": 4,
        "IsDeleted": true,
        "SavedByUser": "sample string 6",
        "SavedDateTime": "2025-11-03T10:21:32.0491734-05:00"
      }
    }
  ]
}

application/xml, text/xml

Sample:

<ResponseWrapperBindingModelOfArrayOfProfileBindingModelEN_PNkT3A xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Prometric.Api.Models">
  <TotalResults>1</TotalResults>
  <Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/Prometric.Registration.Api.Models">
    <d2p1:ProfileBindingModel>
      <d2p1:AddressLine1>sample string 8</d2p1:AddressLine1>
      <d2p1:AddressLine2>sample string 9</d2p1:AddressLine2>
      <d2p1:AddressLine3>sample string 10</d2p1:AddressLine3>
      <d2p1:AddressLine4>sample string 11</d2p1:AddressLine4>
      <d2p1:BirthDate>2025-11-03T10:21:32.0491734-05:00</d2p1:BirthDate>
      <d2p1:City>sample string 12</d2p1:City>
      <d2p1:ClientCode>sample string 25</d2p1:ClientCode>
      <d2p1:Country>sample string 15</d2p1:Country>
      <d2p1:CreateLogin>sample string 28</d2p1:CreateLogin>
      <d2p1:EmailAddress>sample string 7</d2p1:EmailAddress>
      <d2p1:ExamCode>sample string 27</d2p1:ExamCode>
      <d2p1:FaxNumber>sample string 20</d2p1:FaxNumber>
      <d2p1:FirstName>sample string 4</d2p1:FirstName>
      <d2p1:Href>sample string 2</d2p1:Href>
      <d2p1:Id>sample string 1</d2p1:Id>
      <d2p1:LastName>sample string 6</d2p1:LastName>
      <d2p1:MiddleName>sample string 5</d2p1:MiddleName>
      <d2p1:NewEmailAddress>sample string 29</d2p1:NewEmailAddress>
      <d2p1:PostalCode>sample string 14</d2p1:PostalCode>
      <d2p1:PrimaryPhoneExtension>sample string 17</d2p1:PrimaryPhoneExtension>
      <d2p1:PrimaryPhoneNumber>sample string 16</d2p1:PrimaryPhoneNumber>
      <d2p1:ProgramCode>sample string 26</d2p1:ProgramCode>
      <d2p1:PrometricId>sample string 23</d2p1:PrometricId>
      <d2p1:RequiresValidation>true</d2p1:RequiresValidation>
      <d2p1:SecondaryPhoneExtension>sample string 19</d2p1:SecondaryPhoneExtension>
      <d2p1:SecondaryPhoneNumber>sample string 18</d2p1:SecondaryPhoneNumber>
      <d2p1:StateProvince>sample string 13</d2p1:StateProvince>
      <d2p1:SubscribeToEmails>true</d2p1:SubscribeToEmails>
      <d2p1:Suffix>sample string 3</d2p1:Suffix>
      <d2p1:UniqueId xmlns:d4p1="http://schemas.datacontract.org/2004/07/Prometric.Registration.Repository.Models">
        <d4p1:Id>4</d4p1:Id>
        <d4p1:IsDeleted>true</d4p1:IsDeleted>
        <d4p1:SavedByUser>sample string 6</d4p1:SavedByUser>
        <d4p1:SavedDateTime xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
          <d5p1:DateTime>2025-11-03T15:21:32.0491734Z</d5p1:DateTime>
          <d5p1:OffsetMinutes>-300</d5p1:OffsetMinutes>
        </d4p1:SavedDateTime>
        <d4p1:DemographicTemplateDetail>
          <d4p1:DemographicDataTypeName>sample string 9</d4p1:DemographicDataTypeName>
          <d4p1:DemographicId>1</d4p1:DemographicId>
          <d4p1:DisplayGroup>sample string 11</d4p1:DisplayGroup>
          <d4p1:DisplayName>
            <d4p1:DemographicId>1</d4p1:DemographicId>
            <d4p1:DisplayText>sample string 3</d4p1:DisplayText>
            <d4p1:Locale>sample string 2</d4p1:Locale>
          </d4p1:DisplayName>
          <d4p1:IsCustom>true</d4p1:IsCustom>
          <d4p1:IsEditable>true</d4p1:IsEditable>
          <d4p1:IsRequired>true</d4p1:IsRequired>
          <d4p1:IsUnique>true</d4p1:IsUnique>
          <d4p1:IsVisible>true</d4p1:IsVisible>
          <d4p1:MaxLength>1</d4p1:MaxLength>
          <d4p1:Name>sample string 12</d4p1:Name>
          <d4p1:Options>
            <d4p1:DemographicOption>
              <d4p1:DemographicId>1</d4p1:DemographicId>
              <d4p1:Name>sample string 3</d4p1:Name>
              <d4p1:Ordinal>4</d4p1:Ordinal>
              <d4p1:Value>sample string 2</d4p1:Value>
            </d4p1:DemographicOption>
            <d4p1:DemographicOption>
              <d4p1:DemographicId>1</d4p1:DemographicId>
              <d4p1:Name>sample string 3</d4p1:Name>
              <d4p1:Ordinal>4</d4p1:Ordinal>
              <d4p1:Value>sample string 2</d4p1:Value>
            </d4p1:DemographicOption>
          </d4p1:Options>
          <d4p1:Ordinal>10</d4p1:Ordinal>
          <d4p1:ValidRegEx>sample string 7</d4p1:ValidRegEx>
          <d4p1:ValidationMask>sample string 8</d4p1:ValidationMask>
          <d4p1:ValidatorConfigurations>
            <d4p1:DemographicValidatorConfiguration>
              <d4p1:DemographicId>1</d4p1:DemographicId>
              <d4p1:FullyQualifiedName>sample string 3</d4p1:FullyQualifiedName>
              <d4p1:Name>sample string 2</d4p1:Name>
              <d4p1:Ordinal>4</d4p1:Ordinal>
            </d4p1:DemographicValidatorConfiguration>
            <d4p1:DemographicValidatorConfiguration>
              <d4p1:DemographicId>1</d4p1:DemographicId>
              <d4p1:FullyQualifiedName>sample string 3</d4p1:FullyQualifiedName>
              <d4p1:Name>sample string 2</d4p1:Name>
              <d4p1:Ordinal>4</d4p1:Ordinal>
            </d4p1:DemographicValidatorConfiguration>
          </d4p1:ValidatorConfigurations>
        </d4p1:DemographicTemplateDetail>
        <d4p1:DemographicTemplateDetailName>sample string 2</d4p1:DemographicTemplateDetailName>
        <d4p1:ProfileId>1</d4p1:ProfileId>
        <d4p1:UniqueId>sample string 3</d4p1:UniqueId>
      </d2p1:UniqueId>
      <d2p1:Username>sample string 21</d2p1:Username>
      <d2p1:Values xmlns:d4p1="http://schemas.datacontract.org/2004/07/Prometric.Registration.Repository.Models">
        <d4p1:ProfileCustomValue>
          <d4p1:Name>sample string 1</d4p1:Name>
          <d4p1:Value>sample string 2</d4p1:Value>
        </d4p1:ProfileCustomValue>
        <d4p1:ProfileCustomValue>
          <d4p1:Name>sample string 1</d4p1:Name>
          <d4p1:Value>sample string 2</d4p1:Value>
        </d4p1:ProfileCustomValue>
      </d2p1:Values>
    </d2p1:ProfileBindingModel>
    <d2p1:ProfileBindingModel>
      <d2p1:AddressLine1>sample string 8</d2p1:AddressLine1>
      <d2p1:AddressLine2>sample string 9</d2p1:AddressLine2>
      <d2p1:AddressLine3>sample string 10</d2p1:AddressLine3>
      <d2p1:AddressLine4>sample string 11</d2p1:AddressLine4>
      <d2p1:BirthDate>2025-11-03T10:21:32.0491734-05:00</d2p1:BirthDate>
      <d2p1:City>sample string 12</d2p1:City>
      <d2p1:ClientCode>sample string 25</d2p1:ClientCode>
      <d2p1:Country>sample string 15</d2p1:Country>
      <d2p1:CreateLogin>sample string 28</d2p1:CreateLogin>
      <d2p1:EmailAddress>sample string 7</d2p1:EmailAddress>
      <d2p1:ExamCode>sample string 27</d2p1:ExamCode>
      <d2p1:FaxNumber>sample string 20</d2p1:FaxNumber>
      <d2p1:FirstName>sample string 4</d2p1:FirstName>
      <d2p1:Href>sample string 2</d2p1:Href>
      <d2p1:Id>sample string 1</d2p1:Id>
      <d2p1:LastName>sample string 6</d2p1:LastName>
      <d2p1:MiddleName>sample string 5</d2p1:MiddleName>
      <d2p1:NewEmailAddress>sample string 29</d2p1:NewEmailAddress>
      <d2p1:PostalCode>sample string 14</d2p1:PostalCode>
      <d2p1:PrimaryPhoneExtension>sample string 17</d2p1:PrimaryPhoneExtension>
      <d2p1:PrimaryPhoneNumber>sample string 16</d2p1:PrimaryPhoneNumber>
      <d2p1:ProgramCode>sample string 26</d2p1:ProgramCode>
      <d2p1:PrometricId>sample string 23</d2p1:PrometricId>
      <d2p1:RequiresValidation>true</d2p1:RequiresValidation>
      <d2p1:SecondaryPhoneExtension>sample string 19</d2p1:SecondaryPhoneExtension>
      <d2p1:SecondaryPhoneNumber>sample string 18</d2p1:SecondaryPhoneNumber>
      <d2p1:StateProvince>sample string 13</d2p1:StateProvince>
      <d2p1:SubscribeToEmails>true</d2p1:SubscribeToEmails>
      <d2p1:Suffix>sample string 3</d2p1:Suffix>
      <d2p1:UniqueId xmlns:d4p1="http://schemas.datacontract.org/2004/07/Prometric.Registration.Repository.Models">
        <d4p1:Id>4</d4p1:Id>
        <d4p1:IsDeleted>true</d4p1:IsDeleted>
        <d4p1:SavedByUser>sample string 6</d4p1:SavedByUser>
        <d4p1:SavedDateTime xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
          <d5p1:DateTime>2025-11-03T15:21:32.0491734Z</d5p1:DateTime>
          <d5p1:OffsetMinutes>-300</d5p1:OffsetMinutes>
        </d4p1:SavedDateTime>
        <d4p1:DemographicTemplateDetail>
          <d4p1:DemographicDataTypeName>sample string 9</d4p1:DemographicDataTypeName>
          <d4p1:DemographicId>1</d4p1:DemographicId>
          <d4p1:DisplayGroup>sample string 11</d4p1:DisplayGroup>
          <d4p1:DisplayName>
            <d4p1:DemographicId>1</d4p1:DemographicId>
            <d4p1:DisplayText>sample string 3</d4p1:DisplayText>
            <d4p1:Locale>sample string 2</d4p1:Locale>
          </d4p1:DisplayName>
          <d4p1:IsCustom>true</d4p1:IsCustom>
          <d4p1:IsEditable>true</d4p1:IsEditable>
          <d4p1:IsRequired>true</d4p1:IsRequired>
          <d4p1:IsUnique>true</d4p1:IsUnique>
          <d4p1:IsVisible>true</d4p1:IsVisible>
          <d4p1:MaxLength>1</d4p1:MaxLength>
          <d4p1:Name>sample string 12</d4p1:Name>
          <d4p1:Options>
            <d4p1:DemographicOption>
              <d4p1:DemographicId>1</d4p1:DemographicId>
              <d4p1:Name>sample string 3</d4p1:Name>
              <d4p1:Ordinal>4</d4p1:Ordinal>
              <d4p1:Value>sample string 2</d4p1:Value>
            </d4p1:DemographicOption>
            <d4p1:DemographicOption>
              <d4p1:DemographicId>1</d4p1:DemographicId>
              <d4p1:Name>sample string 3</d4p1:Name>
              <d4p1:Ordinal>4</d4p1:Ordinal>
              <d4p1:Value>sample string 2</d4p1:Value>
            </d4p1:DemographicOption>
          </d4p1:Options>
          <d4p1:Ordinal>10</d4p1:Ordinal>
          <d4p1:ValidRegEx>sample string 7</d4p1:ValidRegEx>
          <d4p1:ValidationMask>sample string 8</d4p1:ValidationMask>
          <d4p1:ValidatorConfigurations>
            <d4p1:DemographicValidatorConfiguration>
              <d4p1:DemographicId>1</d4p1:DemographicId>
              <d4p1:FullyQualifiedName>sample string 3</d4p1:FullyQualifiedName>
              <d4p1:Name>sample string 2</d4p1:Name>
              <d4p1:Ordinal>4</d4p1:Ordinal>
            </d4p1:DemographicValidatorConfiguration>
            <d4p1:DemographicValidatorConfiguration>
              <d4p1:DemographicId>1</d4p1:DemographicId>
              <d4p1:FullyQualifiedName>sample string 3</d4p1:FullyQualifiedName>
              <d4p1:Name>sample string 2</d4p1:Name>
              <d4p1:Ordinal>4</d4p1:Ordinal>
            </d4p1:DemographicValidatorConfiguration>
          </d4p1:ValidatorConfigurations>
        </d4p1:DemographicTemplateDetail>
        <d4p1:DemographicTemplateDetailName>sample string 2</d4p1:DemographicTemplateDetailName>
        <d4p1:ProfileId>1</d4p1:ProfileId>
        <d4p1:UniqueId>sample string 3</d4p1:UniqueId>
      </d2p1:UniqueId>
      <d2p1:Username>sample string 21</d2p1:Username>
      <d2p1:Values xmlns:d4p1="http://schemas.datacontract.org/2004/07/Prometric.Registration.Repository.Models">
        <d4p1:ProfileCustomValue>
          <d4p1:Name>sample string 1</d4p1:Name>
          <d4p1:Value>sample string 2</d4p1:Value>
        </d4p1:ProfileCustomValue>
        <d4p1:ProfileCustomValue>
          <d4p1:Name>sample string 1</d4p1:Name>
          <d4p1:Value>sample string 2</d4p1:Value>
        </d4p1:ProfileCustomValue>
      </d2p1:Values>
    </d2p1:ProfileBindingModel>
  </Results>
</ResponseWrapperBindingModelOfArrayOfProfileBindingModelEN_PNkT3A>