1002: Get account data
- Troels Nielsen
- Nick Jensen
Endpoint ID: | 1002 | |||||
| Method: | GET | |||||
| URL: | /entity/id/{entity-id}/data/{contract-id} /entity/ext-key/{ext-key}/{ext-type}/data/{contract-id} | |||||
entity-id | Rubiq entity ID that uniquely identifies an account to return data for | |||||
ext-key | External key that uniquely identifies an 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 Rubiq entity ID 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. Example 1 - Contract specifies full name and email: {
"id": 123456,
"name": "John Doe",
"email": "mailbox@mailserver.com"
}
| |||||
| Status codes: | 200 | Account found with success | ||||
| 404 | Account was not found The following sub codes may be returned:
| |||||