{
  "opencollection": "1.0.0",
  "info": {
    "name": "Particle Cloud Authentication Devices API",
    "version": "1.0.0"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Devices",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List devices",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.particle.io/v1/devices"
          },
          "docs": "List devices the currently authenticated user has access to. By default, devices will be sorted by last_handshake_at in descending order."
        },
        {
          "info": {
            "name": "Claim a device",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.particle.io/v1/devices"
          },
          "docs": "Claim a new or unclaimed device to your account."
        },
        {
          "info": {
            "name": "Get product device information",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.particle.io/v1/products/:productIdOrSlug/devices/:deviceId",
            "params": [
              {
                "name": "productIdOrSlug",
                "value": "",
                "type": "path"
              },
              {
                "name": "deviceId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Get basic information about a given device that is part of a product See Get device information for the response attributes"
        },
        {
          "info": {
            "name": "Get device information",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.particle.io/v1/devices/:deviceId",
            "params": [
              {
                "name": "deviceId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Get basic information about the given device, including the custom variables and functions it has exposed. This can be called for sandbox devices claimed to your account and for product devices you have access to, regardless of claiming."
        },
        {
          "info": {
            "name": "Unclaim device",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.particle.io/v1/devices/:deviceId",
            "params": [
              {
                "name": "deviceId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Remove ownership of a device. This will unclaim regardless if the device is owned by a user or a customer, in the case of a product. When using this endpoint to unclaim a product device, the route looks slightly different: DELETE /v1/products/:productIdOrSlug/devices/:deviceId/owner Note the /owner at the end of the route."
        },
        {
          "info": {
            "name": "Look up device identification from a serial number",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.particle.io/v1/serial_numbers/:serial_number",
            "params": [
              {
                "name": "serial_number",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Return the device ID and SIM card ICCD (if applicable) for a device by serial number. This API can look up devices that you have not yet added to your product and is rate limited to 50 requests per hour. Once you've imported your devices to your product you should instead use the list devices in a product API and filter on serial number. No special rate limits apply to that API."
        },
        {
          "info": {
            "name": "List devices in a product",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.particle.io/v1/products/:productIdOrSlug/devices",
            "params": [
              {
                "name": "productIdOrSlug",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "List all devices that are part of a product. Results are paginated, by default returns 25 device records per page."
        },
        {
          "info": {
            "name": "List device orders for a product",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.particle.io/v1/products/:productIdOrSlug/device_orders",
            "params": [
              {
                "name": "productIdOrSlug",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "List device orders associated with the product's organization. Each element represents a single shiment from a wholesale device order. Returns the full list — not paginated. Sorted by latest_fulfilled_at desc (most recently fulfilled first)."
        },
        {
          "info": {
            "name": "Get a variable value",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.particle.io/v1/devices/:deviceId/:varName",
            "params": [
              {
                "name": "deviceId",
                "value": "",
                "type": "path"
              },
              {
                "name": "varName",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Request the current value of a variable exposed by the device. Variables can be read on a device you own, or for any device that is part of a product you are a team member of."
        },
        {
          "info": {
            "name": "Call a function",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.particle.io/v1/devices/:deviceId/:functionName",
            "params": [
              {
                "name": "deviceId",
                "value": "",
                "type": "path"
              },
              {
                "name": "functionName",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Call a function exposed by the device, with arguments passed in the request body. Functions can be called on a device you own, or for any device that is part of a product you are a team member of."
        },
        {
          "info": {
            "name": "Ping a device",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.particle.io/v1/devices/:deviceId/ping",
            "params": [
              {
                "name": "deviceId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "This will ping a device, enabling you to see if your device is online or offline"
        }
      ]
    }
  ],
  "bundled": true
}