{"article":{"id":23156860318093,"url":"https://preyhq.zendesk.com/api/v2/help_center/en-us/articles/23156860318093.json","html_url":"https://support.preyproject.com/hc/en-us/articles/23156860318093-Developer-API","author_id":4883400747021,"comments_disabled":true,"draft":false,"promoted":false,"position":7,"vote_sum":0,"vote_count":0,"upvote_count":0,"downvote_count":0,"section_id":49328033927181,"created_at":"2024-01-12T16:58:56Z","updated_at":"2026-10-06T13:06:11Z","name":"Developer API","title":"Developer API","source_locale":"en-us","locale":"en-us","outdated":false,"outdated_locales":[],"edited_at":"2026-10-05T23:02:50Z","user_segment_id":null,"permission_group_id":4413418374029,"content_tag_ids":[],"label_names":[],"body":"<p class=\"note\">Available for<br>✔︎ Prey Tracking<br>✔︎ Prey Protection<br>✔︎ Prey Full Suite</p>\n<p> </p>\n<h3 id=\"h_01HKZ9Y17JBZ1BD5BBV5N3FY3Q\">How do I get started?</h3>\n<p>Go to your Settings tab on your <strong>Control Panel</strong>, hit the <strong>Developer API button</strong>, and generate your unique API Key to start developing external integrations to your account and data.</p>\n<p>You can also choose an expiration date, in order for you to revoke permissions.</p>\n<p> </p>\n<p><img src=\"https://d33v4339jhl8k0.cloudfront.net/docs/assets/52938c45e4b0ff3c817b1cc8/images/5eae281b042863474d1a0a28/file-uJOWhQC6Pu.png\"></p>\n<p> </p>\n<h3 id=\"h_01HKZ9YHC8GG0DB5YV6CFEB5S3\">What can I use the Prey API for?</h3>\n<p>In a nutshell, to read and write specific events that you’ll find next, without the need of logging in to your Control Panel.</p>\n<h3 id=\"h_01HKZAAQSGVA58V8KTBQQM5RQ0\">Read</h3>\n<ul>\n<li>\n<strong>Account</strong>: Check your account details, get your automations, reports, devices, labels and users counts, and access the institution and settings details.</li>\n<li>\n<strong>Users</strong>: List all the Prey account users and get their information individually from your account. Check their names, roles, counts and IDs.</li>\n<li>\n<strong>Devices</strong>: Display your Prey account device list and access their data individually. You'll be able to get their operating systems, Prey client running, logged in user, the Wi-Fi network connection, hardware information, battery status, and device information related to automations, zones, labels, reports and loan process.</li>\n<li>\n<strong>Labels</strong>: Retrieve a list of your current active labels, their ID's and your assigned devices.</li>\n<li>\n<strong>Location History</strong>: You can also check up to one month of past locations of a device from your Prey's fleet.</li>\n<li>\n<strong>Control Zones</strong>: Access all your Prey account zones and get data from a particular one.</li>\n<li>\n<strong>Automations</strong>: Check your Prey account Automations and get data from a particular one.</li>\n<li>\n<strong>Mass Actions</strong>: List the Mass Actions created on your account and get individual data from them.</li>\n</ul>\n<h3 id=\"h_01HKZADNC10CD36XMN0C2J9W5S\">Write</h3>\n<ul>\n<li>Run an <strong>Alarm</strong>, <strong>Alert</strong> or <strong>Lock</strong> action.</li>\n<li>Change your devices status to <em>Missing</em> or <em>Recovered</em>.</li>\n<li>Create a <strong>label</strong> and <strong>assign</strong> one to a group of devices.</li>\n</ul>\n<h3 id=\"h_01HKZ9X2E2R31P4AP5KEJ273RK\">Where can I find the documentation?</h3>\n<p>Click <a href=\"https://api.preyproject.com/\">here</a> to go to the API's documentation platform.</p>"}}