GET api/v1/relatives?customerId={customerId}&Limit={Limit}&Offset={Offset}&OrderBy={OrderBy}

Request Information

URI Parameters

Name	Type	Additional information
customerId	globally unique identifier	Required
Limit	integer	None.
Offset	integer	None.
OrderBy	string	None.

Body Parameters

None.

Response Information

Resource Description

MultiResultResponseOfRelativeDto

Name	Description	Type	Additional information
Meta		MetaMultiResult	None.
Notifications			None.

Response Formats

application/json, text/json

Sample:

{
  "meta": {
    "limit": 1,
    "offset": 2,
    "totalResults": 3
  },
  "notifications": [
    {},
    {}
  ],
  "results": [
    {
      "id": "8b168c2c-4282-4df1-b11c-88383491a29c",
      "firstName": "sample string 1",
      "lastName": "sample string 2",
      "birthDate": "2026-03-23T09:15:18.5155585+00:00",
      "gender": 0,
      "type": 0,
      "hasActiveCard": true,
      "customerId": "33526478-b03d-4d1a-9b28-b62d5bf5ce36",
      "relativeFields": {
        "sample string 1": {
          "code": "sample string 1",
          "name": "sample string 2",
          "stringValue": "sample string 3",
          "dateTimeValue": "2026-03-23T09:15:18.5155585+00:00",
          "intValue": 1,
          "boolValue": true,
          "type": "sample string 4"
        },
        "sample string 2": {
          "code": "sample string 1",
          "name": "sample string 2",
          "stringValue": "sample string 3",
          "dateTimeValue": "2026-03-23T09:15:18.5155585+00:00",
          "intValue": 1,
          "boolValue": true,
          "type": "sample string 4"
        }
      }
    },
    {
      "id": "8b168c2c-4282-4df1-b11c-88383491a29c",
      "firstName": "sample string 1",
      "lastName": "sample string 2",
      "birthDate": "2026-03-23T09:15:18.5155585+00:00",
      "gender": 0,
      "type": 0,
      "hasActiveCard": true,
      "customerId": "33526478-b03d-4d1a-9b28-b62d5bf5ce36",
      "relativeFields": {
        "sample string 1": {
          "code": "sample string 1",
          "name": "sample string 2",
          "stringValue": "sample string 3",
          "dateTimeValue": "2026-03-23T09:15:18.5155585+00:00",
          "intValue": 1,
          "boolValue": true,
          "type": "sample string 4"
        },
        "sample string 2": {
          "code": "sample string 1",
          "name": "sample string 2",
          "stringValue": "sample string 3",
          "dateTimeValue": "2026-03-23T09:15:18.5155585+00:00",
          "intValue": 1,
          "boolValue": true,
          "type": "sample string 4"
        }
      }
    }
  ]
}

application/xml, text/xml

Sample:

<MultiResultResponseOfRelativeDtoaM_S85dVU xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Presentation.WebApi.Dtos.Response">
  <Meta>
    <Limit>1</Limit>
    <Offset>2</Offset>
    <TotalResults>3</TotalResults>
  </Meta>
  <Notifications>
    <Notification />
    <Notification />
  </Notifications>
  <Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/Domain.Dtos">
    <d2p1:RelativeDto>
      <d2p1:BirthDate>2026-03-23T09:15:18.5155585+00:00</d2p1:BirthDate>
      <d2p1:CustomerId>33526478-b03d-4d1a-9b28-b62d5bf5ce36</d2p1:CustomerId>
      <d2p1:FirstName>sample string 1</d2p1:FirstName>
      <d2p1:Gender>Male</d2p1:Gender>
      <d2p1:HasActiveCard>true</d2p1:HasActiveCard>
      <d2p1:Id>8b168c2c-4282-4df1-b11c-88383491a29c</d2p1:Id>
      <d2p1:LastName>sample string 2</d2p1:LastName>
      <d2p1:RelativeFields xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringRelativeFieldDtouOHOlRpi>
          <d4p1:Key>sample string 1</d4p1:Key>
          <d4p1:Value>
            <d2p1:BoolValue>true</d2p1:BoolValue>
            <d2p1:Code>sample string 1</d2p1:Code>
            <d2p1:DateTimeValue>2026-03-23T09:15:18.5155585+00:00</d2p1:DateTimeValue>
            <d2p1:IntValue>1</d2p1:IntValue>
            <d2p1:Name>sample string 2</d2p1:Name>
            <d2p1:StringValue>sample string 3</d2p1:StringValue>
            <d2p1:Type>sample string 4</d2p1:Type>
          </d4p1:Value>
        </d4p1:KeyValueOfstringRelativeFieldDtouOHOlRpi>
        <d4p1:KeyValueOfstringRelativeFieldDtouOHOlRpi>
          <d4p1:Key>sample string 2</d4p1:Key>
          <d4p1:Value>
            <d2p1:BoolValue>true</d2p1:BoolValue>
            <d2p1:Code>sample string 1</d2p1:Code>
            <d2p1:DateTimeValue>2026-03-23T09:15:18.5155585+00:00</d2p1:DateTimeValue>
            <d2p1:IntValue>1</d2p1:IntValue>
            <d2p1:Name>sample string 2</d2p1:Name>
            <d2p1:StringValue>sample string 3</d2p1:StringValue>
            <d2p1:Type>sample string 4</d2p1:Type>
          </d4p1:Value>
        </d4p1:KeyValueOfstringRelativeFieldDtouOHOlRpi>
      </d2p1:RelativeFields>
      <d2p1:Type>Son</d2p1:Type>
    </d2p1:RelativeDto>
    <d2p1:RelativeDto>
      <d2p1:BirthDate>2026-03-23T09:15:18.5155585+00:00</d2p1:BirthDate>
      <d2p1:CustomerId>33526478-b03d-4d1a-9b28-b62d5bf5ce36</d2p1:CustomerId>
      <d2p1:FirstName>sample string 1</d2p1:FirstName>
      <d2p1:Gender>Male</d2p1:Gender>
      <d2p1:HasActiveCard>true</d2p1:HasActiveCard>
      <d2p1:Id>8b168c2c-4282-4df1-b11c-88383491a29c</d2p1:Id>
      <d2p1:LastName>sample string 2</d2p1:LastName>
      <d2p1:RelativeFields xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringRelativeFieldDtouOHOlRpi>
          <d4p1:Key>sample string 1</d4p1:Key>
          <d4p1:Value>
            <d2p1:BoolValue>true</d2p1:BoolValue>
            <d2p1:Code>sample string 1</d2p1:Code>
            <d2p1:DateTimeValue>2026-03-23T09:15:18.5155585+00:00</d2p1:DateTimeValue>
            <d2p1:IntValue>1</d2p1:IntValue>
            <d2p1:Name>sample string 2</d2p1:Name>
            <d2p1:StringValue>sample string 3</d2p1:StringValue>
            <d2p1:Type>sample string 4</d2p1:Type>
          </d4p1:Value>
        </d4p1:KeyValueOfstringRelativeFieldDtouOHOlRpi>
        <d4p1:KeyValueOfstringRelativeFieldDtouOHOlRpi>
          <d4p1:Key>sample string 2</d4p1:Key>
          <d4p1:Value>
            <d2p1:BoolValue>true</d2p1:BoolValue>
            <d2p1:Code>sample string 1</d2p1:Code>
            <d2p1:DateTimeValue>2026-03-23T09:15:18.5155585+00:00</d2p1:DateTimeValue>
            <d2p1:IntValue>1</d2p1:IntValue>
            <d2p1:Name>sample string 2</d2p1:Name>
            <d2p1:StringValue>sample string 3</d2p1:StringValue>
            <d2p1:Type>sample string 4</d2p1:Type>
          </d4p1:Value>
        </d4p1:KeyValueOfstringRelativeFieldDtouOHOlRpi>
      </d2p1:RelativeFields>
      <d2p1:Type>Son</d2p1:Type>
    </d2p1:RelativeDto>
  </Results>
</MultiResultResponseOfRelativeDtoaM_S85dVU>