×

Login to Safe Shepherd

Recover your password

Safe Shepherd API Documentation

Get all user records

Get all record information for a given user

GET /api/:integration_name/:api_key/v2/users/:user_id/records(.:format)

Parameters

api_key
API access key - String*
api_secret
API secret key - String*
user_id
User ID returned during user creation - Integer*
secret
Secret associated with user account during creation - Integer*

Returns

HTTP 401 - Unauthorized

If api_key missing or invalid, or Dependent / Dependent-Secret mismatch

HTTP 400 - Bad Request

If fields missing or invalid

HTTP 200 - Success

Returns JSON/XML-encoded list of <record> structs

View Example
{
  "records": [
    {
      "record": {
        "id": 412,
        "name": "Winston Churchill",
        "site": "Zaba Search",
        "status": "removed",
        "age": 55,
        "href": "http://churchilldowns.com",
        "relations": [
          "Mindy Churchill"
        ],
        "aliases": [
          "The Boss"
        ],
        "locations": [
          "Buffalo, NY"
        ],
        "reference_id": "34abtdfjl3-2"
      }
    }
  ]
}