Device Magic
Mobile data collection and workflow automation platform
| API | Protocol | Base URL | Docs | Reference | OpenAPI | SDKs |
|---|---|---|---|---|---|---|
| Main | rest | https://api.devicemagic.com/ | link | — | — | — |
Actions (47)
Devices · 10
- Approve devicePOST /organizations/{org_id}/devices/{device_id}/approve
Approve a device pending approval.
documented - Approve devicePOST /organizations/{org_id}/devices/{device_id}/approve
Approve a device that is pending approval.
documented - Delete deviceDELETE /organizations/{org_id}/devices/{device_id}
Remove a device from the organization.
documented - Delete deviceDELETE /organizations/{org_id}/devices/{device_id}
Remove a device from the organization.
documented - Get deviceGET /organizations/{org_id}/devices/{device_id}.(xml|json)
Retrieve details for a specific device.
documented - Get deviceGET /organizations/{org_id}/devices/{device_id}.(xml|json)
Return a single device by ID or identifier.
documented - List devicesGET /organizations/{org_id}/devices.(xml|json)
Return all devices for the organization.
documented - List devicesGET /organizations/{org_id}/devices.(xml|json)
Retrieve all devices in the specified organization.
documented - Update devicePUT /organizations/{org_id}/devices/{device_id}
Update device properties (owner, description, groups, etc.).
documented - Update devicePUT /organizations/{org_id}/devices/{device_id}
Update properties of a device (owner, description, groups, etc.).
documented
Dispatches · 10
- Destroy all dispatchesPOST /api/v2/devices/{device_identifier}/dispatches/destroy_all.(xml|json)
Revoke all dispatches for a device.
documented - Dispatch form (JSON)POST /api/v2/devices/{device_identifier}/dispatches.json
Push a form to a device (JSON payload).
documented - Dispatch form (XML)POST /api/v2/devices/{device_identifier}/dispatches.xml
Push a form to a device (XML payload).
documented - List devicesGET /organizations/{organization_id}/devices.(xml|json)
List devices in the organization (needed for dispatching).
documented - List outstanding dispatched forms (device)GET /api/v2/devices/{device_identifier}/dispatches.(xml|json)
List outstanding dispatched forms for a device.
documented - List outstanding dispatched forms (organization)GET /api/v2/organizations/{organization_id}/dispatches.(xml|json)
List outstanding dispatched forms for an organization.
documented - Retrieve dispatched values (device)GET /api/v3/devices/{device_identifier}/dispatches/{dispatch_id}.(xml|json)?include_inputs=true
Get dispatched values for a specific device/dispatch.
documented - Retrieve dispatched values (user)GET /api/v3/users/{user_identifier}/dispatches/{dispatch_id}.(xml|json)?include_inputs=true
Get dispatched values for a specific user/dispatch.
documented - Revoke dispatched formDELETE /api/v2/devices/{device_identifier}/dispatches/{dispatch_id}.(xml|json)
Delete a dispatched form.
documented - Update dispatchPATCH /api/v2/devices/{device_identifier}/dispatches/{dispatch_id}.(xml|json)
Modify a dispatched form’s fields.
documented
Groups · 8
- Create groupsPOST /api/v2/organizations/{org_id}/groups
Create groups for an organization (v2).
documented - Delete groupDELETE /api/v2/organizations/{org_id}/groups/{group_id}
Delete a group.
documented - Filter groupsGET /api/v2/organizations/{org_id}/groups.json?filter={term}
Filter groups by a substring (v2).
documented - Filter groups by tagsGET /api/v2/organizations/{org_id}/groups.json?tags[]={tag}
Filter groups by tags (v2).
documented - List groups (v1)GET /organizations/{org_id}/groups
List groups for an organization (v1).
documented - List groups (v2)GET /api/v2/organizations/{org_id}/groups.(xml|json)
List groups for an organization (v2).
documented - Update groupPUT /api/v2/organizations/{org_id}/groups/{group_id}
Update a group's name, form_ids, and device_ids.
documented - Update group (v1)PUT /organizations/{org_id}/groups/{group_id}
Update a group (v1) with name/form_ids/device_ids.
documented
Forms · 6
- Create formPOST /organizations/{organization_id}/forms
Create a new form (XML or JSON definition).
documented - Delete formDELETE /organizations/{organization_id}/forms/{form_id}
Delete a form.
documented - Get formGET /organizations/{organization_id}/forms/{form_id}.(xml|json)
Fetch a form's definition (XML or JSON).
documented - List formsGET /organizations/{organization_id}/forms.(xml|json)
Retrieve all forms in the organization.
documented - Update formPUT /organizations/{organization_id}/forms/{form_id}
Update an existing form definition.
documented - Update form groupPOST /organizations/{organization_id}/forms/{form_id}/properties
Update the group for a form (publish/unpublish via properties).
documented
Resources · 6
- Create resourcePOST /api/v3/resources.json
Upload a new resource (with file data and metadata).
documented - Delete resourceDELETE /api/resources/{resource_id}
Delete a resource by ID.
documented - Describe resourceGET /api/resources/{resource_id}/describe.(xml|json)
View details for a specific resource.
documented - Download resourceGET /api/resources/{resource_id}
Download a specific resource by ID.
documented - List resourcesGET /api/resources.(xml|json)
List all resources for the organization.
documented - Update resourcePUT /api/v3/resources/{resource_id}.json
Update an existing resource and its file data.
documented
Destinations · 5
- Create destinationPOST /api/forms/{form_id}/destinations.json
Create a new destination for a form.
documented - Delete destinationDELETE /api/forms/{form_id}/destinations/{destination_id}
Remove a destination from a form.
documented - Get destinationGET /api/forms/{form_id}/destinations/{destination_id}.json
Get details of a specific destination.
documented - List destinationsGET /api/forms/{form_id}/destinations.(xml|json)
List all destinations for a given form.
documented - Update destinationPUT /api/forms/{form_id}/destinations/{destination_id}.json
Update an existing destination.
documented
Device Magic Database · 2
- List submissions in Device Magic DatabaseGET /api/forms/{form_id}/device_magic_database.json
Retrieve submissions stored in a form’s Device Magic Database destination.
documented - Paginate database submissionsGET /api/forms/{form_id}/device_magic_database.json?per_page={per_page}
Paginate through Device Magic Database submissions (per_page controls page size).
documented