RetrieveEmployeeRole

v1.0.0

Provides the details for a single employee role.

Input

{
  "type": "object",
  "properties": {
    "role_id": {
      "type": "string"
    }
  },
  "required": [
    "role_id"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "description": "V1EmployeeRole",
  "required": [
    "name",
    "permissions"
  ],
  "properties": {
    "created_at": {
      "type": "string",
      "description": "The time when the employee entity was created, in ISO 8601 format. Is set by Square when the Role is created."
    },
    "id": {
      "type": "string",
      "description": "The role's unique ID, Can only be set by Square."
    },
    "is_owner": {
      "type": "boolean",
      "description": "If true, employees with this role have all permissions, regardless of the values indicated in permissions."
    },
    "name": {
      "type": "string",
      "description": "The role's merchant-defined name."
    },
    "permissions": {
      "type": "array",
      "description": "The role's permissions.",
      "items": {
        "type": "string"
      }
    },
    "updated_at": {
      "type": "string",
      "description": "The time when the employee entity was most recently updated, in ISO 8601 format. Is set by Square when the Role updated."
    }
  }
}