Skip to main content
GET
/
roles
Read role
curl --request GET \
  --url https://apiweb.mile.app/api/v3/roles \
  --header 'Authorization: Bearer <token>'
{
  "properties": {
    "status": {
      "description": "Status of response.",
      "type": "string"
    },
    "data": {
      "description": "List of roles.",
      "type": "object",
      "additionalProperties": true
    }
  },
  "example": {
    "data": [
      {
        "_id": "6449f8ef2c481b07d40ecfc3",
        "name": "owner",
        "isAdmin": true,
        "isDefault": true,
        "isDeleted": false,
        "permissionList": [
          "6156d6475320c9679e337eba",
          "615ac4ab5c3c0b3d3e83dfc1",
          "615ac4ab5c3c0b3d3e83dfc2",
          "615ac5175c3c0b3d3e83dfc3",
          "615ac5185c3c0b3d3e83dfc5",
          "615ac5185c3c0b3d3e83dfc6",
          "615ac5185c3c0b3d3e83dfc7",
          "615ac5195c3c0b3d3e83dfc8",
          "615ac5195c3c0b3d3e83dfc9",
          "615ac5625c3c0b3d3e83dfca",
          "615ac5635c3c0b3d3e83dfcb",
          "615ac5635c3c0b3d3e83dfcc",
          "6163b9f723c7545255411653",
          "6163b9f823c7545255411655",
          "6163b9f823c7545255411656",
          "61699635faf2a008e491e117",
          "61699635faf2a008e491e118",
          "61699636faf2a008e491e119",
          "61710b3e83e2af47aa833dfd",
          "61725da59e28573f25d21433",
          "619df73f4b17064cfff6d3f1",
          "619df73f4b17064cfff6d3f2",
          "619df73f4b17064cfff6d3f3",
          "61a589a721d8e9691727abca",
          "61a589a721d8e9691727abcb",
          "61a589a821d8e9691727abcc",
          "61a589a821d8e9691727abcd",
          "61a589a921d8e9691727abcf",
          "61a589aa21d8e9691727abd0",
          "61a589aa21d8e9691727abd1",
          "61a589ab21d8e9691727abd2",
          "61d3f0a024406248b48614b3",
          "61d3f0d524406248b48615b9",
          "61d3f0fe24406248b48616ac",
          "61d3f12d24406248b48617d9",
          "61d3f19324406248b4861909",
          "61d3f1a224406248b4861991",
          "61d3f1b624406248b48619be",
          "61d3f24524406248b4861c20",
          "61d3f25424406248b4861ca1",
          "622578a0e9afc432da65dac1",
          "622578a0e9afc432da65dac2",
          "622578a0e9afc432da65dac3",
          "622578a0e9afc432da65dac4",
          "622b338c2edf688a1d57cdaa",
          "622b33af2edf688a1d57ce21",
          "622b3e492edf688a1d57f49a",
          "6257cc1e475945cff40aea6b",
          "62554e48475945cff4f7a7de",
          "627cb24e62e252387d3bd03d",
          "627cb24e62e252387d3bd03f",
          "627dfeadafaf4c30b52e62ad",
          "627dfeadafaf4c30b52e62af",
          "62c7eb1203c741efeeb6cc8c",
          "62c7eb1203c741efeeb6cc8d",
          "62c7eb1203c741efeeb6cc8e",
          "62c7eb1203c741efeeb6cc8f",
          "631025d1267dfb33da11f9dd",
          "631025d1267dfb33da11f9de",
          "63edc5a74dfe56be43b641c3",
          "63edc5a74dfe56be43b641c4",
          "63edc5a74dfe56be43b641c5",
          "63edc5a74dfe56be43b641c6",
          "63edc5a74dfe56be43b641c7",
          "63edc5a74dfe56be43b641c8",
          "63edc5a74dfe56be43b641c9",
          "63edc5a74dfe56be43b641ca"
        ],
        "permissionDetails": [
          {
            "permissionName": "view/checkincheckout",
            "interval": null,
            "checkinRadius": null,
            "checkoutRadius": null
          }
        ],
        "organizationId": "6449f8ef2c481b07d40ecfc2",
        "updatedTime": "2023-04-27T04:24:15.217000Z",
        "createdTime": "2023-04-27T04:24:15.217000Z"
      }
    ],
    "status": true
  }
}

Authorizations

Authorization
string
header
required

Use a valid Bearer token to authenticate.

Response

Success

The response is of type object.