Handling responses
Making Requests
All API calls require the Medable-Client-Key
header. An Organization creates one or more applications, providing the public key to all its clients. Note that some web applications may employ the Medable-Csrf-Token
. If an application is configured as such, each authenticated request must include HTTP response header of the same name, sent with the login response (and each subsequent authenticated response).
Example: GET/accounts/me
Handling Responses
API responses always consist of JSON documents with an object property, whose values will either list or the name of the object type, such as account
or connection
.
Example: Single Object Response
GET/account
When the response is an array, the data
property contains the resulting array, and the hasMore
property contains a boolean value that is true if there are more results that can be retrieved using Paging.
Example: Multiple Object Response
GET /c_examples?limit=1
If the response is a fault, the object property will be fault (see Faults).
GET /accounts/5516ee2634d8d93428169c0e/profile/missing
Some responses, such as those retrieved via direct Property Access, will have result
as their object property, as they do not represent a concrete, registered object type. Note, however, that directly accessed array properties will always be list
objects.
Result Example
List Example
Last updated
Was this helpful?