Box Developer Documentation
Log in
Latest version

Get device pin

get
https://api.box.com/2.0
/device_pinners/:device_pinner_id

This endpoint is in the version 2024.0. No changes are required to continue using it. For more details, see Box API versioning.

Retrieves information about an individual device pin.

Request

bearer [ACCESS_TOKEN]
application/json

Path Parameters

stringin pathrequired
2324234

The ID of the device pin.

Response

application/jsonDevice pinner

Returns information about a single device pin.

application/jsonClient error

An unexpected client error.

get
Get device pin
You can now try out some of our APIs live, right here in the documentation.
Log in

Request Example

Learn more about Box SDK versioning strategy.


cURL
curl -i -X GET "https://api.box.com/2.0/device_pinners/2324234" \
     -H "authorization: Bearer <ACCESS_TOKEN>"
Node/TypeScript v10
await client.devicePinners.getDevicePinnerById(devicePinnerId);
Python v10
client.device_pinners.get_device_pinner_by_id(device_pinner_id)
.NET v10
await client.DevicePinners.GetDevicePinnerByIdAsync(devicePinnerId: devicePinnerId);
Swift v10
try await client.devicePinners.getDevicePinnerById(devicePinnerId: devicePinnerId)
Java v10
client.getDevicePinners().getDevicePinnerById(devicePinnerId)
Java v5
BoxDevicePin devicePin = new BoxDevicePin(api, id);
BoxDevicePin.Info devicePinInfo = devicePin.getInfo();
Python v4
device_pin_id = '1111'
device_pin = client.device_pinner(device_pin_id).get()
print(f'{pin.product_name} device for {pin.owned_by.name} is pinned')
.NET v6
BoxDevicePin pin = await client.DevicePinManager.GetDevicePin(id: "11111");
Node v4
client.devicePins.get('11111')
    .then(pin => {
        /* pin -> {
            type: 'device_pinner',
            id: '11111',
            owned_by: 
            {
                type: 'user',
                id: '22222',
                name: 'Example User',
                login: 'user@example.com'
            },
            product_name: 'iPad'
        }
        */
    });

Response Example

{
  "id": "11446498",
  "type": "device_pinner",
  "owned_by": {
    "id": "11446498",
    "type": "user",
    "login": "ceo@example.com",
    "name": "Aaron Levie"
  },
  "product_name": "iPad"
}