//sync_key/:sync_key_field_value GET
Overview
Retrieves the record with the given sync_key.
Request Arguments
| Name | Type | Description | Required |
|---|---|---|---|
| module | String | The module the record belongs to | True |
| sync_key_field_value | String | A unique ID for the record identifying it in an external system | True |
Request
/<module>/sync_key/:sync_key_field_value
Response Arguments
Body: formatted JSON object.
Response
Successful Response
Status 200
Failed Response
Status 422
{
"error": "invalid_parameter",
"error_message": "Could not find record with :sync_key_field_value in module: <module>"
}
Change Log
| Version | Change |
|---|---|
| v11_10 | Added /<module>/sync_key/:sync_key_field_value GET endpoint. |