Sign in

v1

latestOpenAPI 3.0.4MIT2026-08-0417157271.9 KB
Destination

Get a single Client Destination by DestinationId

Both methods are valid and return the same result: a single Destination entity identified by its unique DestinationId. The path-style is more intuitive and commonly used in RESTful APIs. The function-style follows OData conventions and may be required in certain query contexts (e.g., when the key contains special characters or is not a simple numeric ID).

<b>Path-style access: </b>/odata/v1/Destination/{DestinationKey}

<b>Example: </b>/odata/v1/Destination/1301

<b>Function-style access: </b>/odata/v1/Destination({DestinationKey})

<b>Example: </b>/odata/v1/Destination(1301)

get/odata/v1/Destination/{DestinationKey}

Path parameters

DestinationKeystring required

Query parameters

$selectstring

Selects which properties to include in the response.

Response

OK (DDF.Core.Entities.Destination object)

@odata.contextstring nullable
DestinationIdinteger

A unique identifier for this record.

DestinationNamestring nullable

The name of the destination.

DestinationUrlstring nullable

The URL to the destination referenced by this record.

DestinationType1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 nullable

The type of destination. i.e. Technology Provider, Partner, etc.

DestinationStatus1 | 2 | 3 nullable

The status of the destination. i.e. Active, Inactive, Suspended

MemberFirstNamestring nullable

The first name of the member.

MemberLastNamestring nullable

The last name of the member.

MemberKeystring nullable

The unique identifier (MemberKey) of the member who owns the destination.

OriginalEntryTimestampstring date-time nullable

Date/time the destination record was originally input into the source system (in Zulu time (UTC)).

ModificationTimestampstring date-time nullable

Date/time the destination record was last modified (in Zulu time (UTC)).

FullNSPboolean

A flag indicating that if the destination is Full NSP.

Example response

{
  "@odata.context": "https://localhost:7051/odata/v1/$metadata#DDF.Core.Entities.Destination"
}