API Reference

Learn how to access UNLOQ end points

GET /widgets/:id

Read information about a given widget

GET https://api.unloq.io/v1/widgets/:id
Headers:
   Authorization: Bearer {your application API Key}
   Content-Type: application/json
URL parameters
  • id (string, required) - The id of the widget to be read.
Result format (200 OK)
{
  "type": "api.application.widget.read",
  "result": {
    "id": "123456",
    "lang": "en",
    "name": "Register widget",
    "type": "REGISTER",
    "is_active": true,
    "has_watermark": true,
    "environment": "LIVE",
    "organization_id": "1",
    "application_id": "1",
    "created_at": "2016-10-18T11:23:28.000Z",
    "color": {
      "primary": "#5c5d5d",
      "secondary": "#000000",
      "link": "#3da0e3",
      "error": ""
    },
    "path": "/",
    "domain": {
      "id": "1234",
      "protocol": "HTTPS",
      "hostname": "example.com",
      "port": 443,
      "is_sandbox": false,
      "organization_id": "1",
      "href": "https://example.com",
      "is_verified": false,
      "verify_key": "abcd_1234"
    }
  }
}
      

Have a question? You can always send us an email at support@unloq.io, or contact us on chat.

For security related concerns, please visit our Security page.