Colleague

A colleague is a member of the current user’s account.

• Get all colleagues
• Get data for a colleague

Get all colleagues

GET /colleagues

Response

Status: 200 OK

{
  "colleagues": [
    {
      "name": "Jane Doe",
      "links": [
        {
          "rel": "self",
          "href": "https://portal.cryptorage.com/api/colleagues/23"
        }
      ]
    },
    {
      "name": "James Does",
      "links": [
        {
          "rel": "self",
          "href": "https://portal.cryptorage.com/api/colleagues/42"
        }
      ]
    }
  ]
}

Error

Status: 404 Not Found

{
  "error": "ERR_ACCOUNT_NOT_FOUND"
}

General error

Status: 500 Server Error

error message

Get data for a colleague

GET /colleagues/:id

Response

Status: 200 OK

{
  "colleague": {
    "id": 23,
    "givenname": "John",
    "surname": "Doe",
    "language": "en",
    "channel": "mobile",
    "links": [
      {
        "rel": "self",
        "href": "https://portal.cryptorage.com/api/colleagues/23"
      }
    ]
  }
}

Error

Status: 404 Not Found

{
  "error": "ERR_COLLEAGUE_NOT_FOUND"
}

General error

Status: 500 Server Error

error message