Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Endpoint ID:1002
Method:GET
URL:

/user/dp-key/

Highlight
dp-key

/data/{

Highlight
contract-id
}

/user/ext-key/{ext-key}/{ext-type}/data/{contract-id}

 

 

dp-key

dialogportal™ master key that uniquely identifies account to return data for

 

ext-key

External key that uniquely identifies account to return data for

 

ext-type

Type of external key

 

contract-id

Identifies the set of contract fields to return. If omitted, the default contract for the particular app is used.

Request body:None 
Response body:

JSON data with properties corresponding to the fields in the specified contract. The result will always hold the dialogportal™ master key and if the app making the request is configured to use a specific external key, this key is also included in the response.

Please note that fields with null value is not returned by this end point.

Code Block
titleExample 1 - Contract specifies full name and email:
{
	"dpKey": 123456,
	"name": "John Doe",
	"email": "mailbox@mailserver.com"
}
Status codes:200

Account found with success

 404

Account was not found