BObox
Device pinners

List enterprise device pins

Changed on

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.

get/enterprises/{enterprise_id}/device_pinners

Request

  • Base URL
    https://api.box.com/2.0
  • URL
    https://api.box.com/2.0/enterprises/{enterprise_id}/device_pinners
  • Auth
    OAuth 2
    Authorization code: https://account.box.com/api/oauth2/authorize
    Token URL: https://api.box.com/oauth2/token

Path parameters

enterprise_idstring required

The ID of the enterprise.

Query parameters

markerstring

Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination.

This requires usemarker to be set to true.

limitinteger

The maximum number of items to return per page.

direction'ASC' | 'DESC'

The direction to sort results in. This can be either in alphabetical ascending (ASC) or descending (DESC) order.

Response

Returns a list of device pins for a given enterprise.

limitinteger

The limit that was used for these entries. This will be the same as the limit query parameter unless that value exceeded the maximum value allowed.

next_markerinteger

The marker for the start of the next page of results.

Example response

{
  "entries": [
    {
      "id": "11446498",
      "type": "device_pinner",
      "owned_by": {
        "id": "11446498",
        "type": "user",
        "name": "Aaron Levie",
        "login": "ceo@example.com"
      },
      "product_name": "iPad"
    }
  ],
  "limit": 200,
  "next_marker": 3000,
  "order": [
    {
      "by": "id",
      "direction": "asc"
    }
  ]
}

Changes

  • c4d5303fa5c3Revision changes
    • warning

      added the new unprocessable_entity enum value to the response property for the response status