HEhexclave
Contact Channels

List contact channels

Changed on

Retrieves a list of all contact channels for a user.

get/contact-channels

Request

  • Base URL
    https://api.hexclave.com/api/v1
  • URL
    https://api.hexclave.com/api/v1/contact-channels
  • Auth
    none declared

Query parameters

user_idstring

The ID of the user, or the special value me for the currently authenticated user

Example:3241a285-8329-4d69-8f3d-316e08cf140c
contact_channel_idstring

Response

Successful response

Example response

{
  "items": [
    {
      "user_id": "3241a285-8329-4d69-8f3d-316e08cf140c",
      "id": "b3d396b8-c574-4c80-97b3-50031675ceb2",
      "value": "johndoe@example.com",
      "type": "email",
      "used_for_auth": true,
      "is_verified": true,
      "is_primary": true
    }
  ],
  "pagination": {
    "next_cursor": "b3d396b8-c574-4c80-97b3-50031675ceb2"
  }
}

Changes

  • ae5572197e85Revision changes
    • breaking

      the response property / became nullable for the status

    • warning

      added the new undefined enum value to the / response property for the response status

  • f6aec844c9f2Revision changes
    • warning

      added the new email enum value to the // response property for the response status