List enterprise device pins

v1.0.0

Retrieves all the device pins within an enterprise.

The user must have admin privileges, and the application needs the "manage enterprise" scope to make this call.

Input

{
  "type": "object",
  "properties": {
    "direction": {
      "type": "string",
      "enum": [
        "ASC",
        "DESC"
      ]
    },
    "enterprise_id": {
      "type": "string"
    },
    "limit": {
      "type": "integer",
      "format": "int64"
    },
    "marker": {
      "type": "string"
    }
  },
  "required": [
    "enterprise_id"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "description": "A list of device pins",
  "properties": {
    "entries": {
      "type": "array",
      "items": {
        "type": "object",
        "description": "Device pins allow enterprises to control what devices can\nuse native Box applications.",
        "properties": {
          "id": {
            "type": "string",
            "description": "The unique identifier for this device pin."
          },
          "owned_by": {
            "type": "object"
          },
          "product_name": {
            "type": "string",
            "description": "The type of device being pinned"
          },
          "type": {
            "type": "string",
            "description": "`device_pinner`",
            "enum": [
              "device_pinner"
            ]
          }
        }
      }
    },
    "limit": {
      "type": "integer",
      "format": "int64",
      "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed."
    },
    "next_marker": {
      "type": "integer",
      "format": "int64",
      "description": "The marker for the start of the next page of results."
    },
    "order": {
      "type": "array",
      "description": "The order by which items are returned.",
      "items": {
        "type": "object",
        "description": "The order in which a pagination is ordered",
        "properties": {
          "by": {
            "type": "string",
            "description": "The field that is ordered by",
            "enum": [
              "id"
            ]
          },
          "direction": {
            "type": "string",
            "description": "The direction to order by, either ascending or descending",
            "enum": [
              "asc",
              "desc"
            ]
          }
        }
      }
    }
  }
}