Device data model

Updated:

View field support, webhooks, and list parameters for each integration on the Supported Integrations page.

FieldTypeRequiredDescription
idstringNo
created_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
namestringNo
asset_tagstringNo
versionstringNodevice version
manufacturerstringNodevice manufacturer
modelstringNodevice model
osstringNooperating system name
os_versionstringNo
user_idsstring[]Nousers who have this device
admin_user_idsstring[]No(reference to HrisEmployee)
location_idstringNopointer to HR Location object (reference to HrisLocation)
has_antivirusbooleanNo
has_password_managerbooleanNo
has_firewallbooleanNo
has_hd_encryptedbooleanNo
has_screenlockbooleanNo
is_missingbooleanNo
metadataHrisMetadata[]No
metadata[].idstringNoThe ID of the custom field definition (from the metadata/metadata endpoint).
metadata[].valueobjectNoThe field's value, typed by format: DATE as ISO-8601 (YYYY-MM-DD, or YYYY-MM-DDTHH:MM:SSZ for date-times); NUMBER, PRICE and CURRENCY as a number; BOOLEAN and YES_NO as true/false; MULTIPLE_SELECT as an array of option values; otherwise a string.
metadata[].namespacestringNo
metadata[].formatenumNoThe data type of the custom field, which determines how value is formatted. Values: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE_SELECT, MULTIPLE_SELECT, MEASUREMENT, PRICE, YES_NO, CURRENCY, URL
metadata[].extra_dataobjectNo
metadata[].slugstringNoThe integration's API name (key) of an existing custom field. List valid slugs for this object with the metadata/metadata endpoint; unknown slugs are rejected by the integration.

TypeScript

TypeScript
export type HrisDevice = {
	id?: string;
	created_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	updated_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	name?: string;
	asset_tag?: string;
	version?: string; // device version
	manufacturer?: string; // device manufacturer
	model?: string; // device model
	os?: string; // operating system name
	os_version?: string;
	user_ids?: string[]; // users who have this device
	admin_user_ids?: string[]; // (reference to HrisEmployee)
	location_id?: string; // pointer to HR Location object (reference to HrisLocation)
	has_antivirus?: boolean;
	has_password_manager?: boolean;
	has_firewall?: boolean;
	has_hd_encrypted?: boolean;
	has_screenlock?: boolean;
	is_missing?: boolean;
	metadata?: [];
	raw?: any;
} 

Zod

Zod
import { z } from 'zod';

export const ZodHrisDevice = z.object({
	id: z.string().optional(),
	created_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	updated_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	name: z.string().optional(),
	asset_tag: z.string().optional(),
	version: z.string().optional().describe("device version"),
	manufacturer: z.string().optional().describe("device manufacturer"),
	model: z.string().optional().describe("device model"),
	os: z.string().optional().describe("operating system name"),
	os_version: z.string().optional(),
	user_ids: z.array().optional().describe("users who have this device"),
	admin_user_ids: z.array().optional().describe("(reference to HrisEmployee)"),
	location_id: z.string().optional().describe("pointer to HR Location object (reference to HrisLocation)"),
	has_antivirus: z.boolean().optional(),
	has_password_manager: z.boolean().optional(),
	has_firewall: z.boolean().optional(),
	has_hd_encrypted: z.boolean().optional(),
	has_screenlock: z.boolean().optional(),
	is_missing: z.boolean().optional(),
	metadata: z.array().optional(),

});

Python

Python
import dataclasses

@dataclasses.dataclass
class HrisDevice:
	id: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	created_at: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	updated_at: Optional[str]
	name: Optional[str]
	asset_tag: Optional[str]
	"""device version"""
	version: Optional[str]
	"""device manufacturer"""
	manufacturer: Optional[str]
	"""device model"""
	model: Optional[str]
	"""operating system name"""
	os: Optional[str]
	os_version: Optional[str]
	"""users who have this device"""
	user_ids: Optional[List[List[str]]]
	"""(reference to HrisEmployee)"""
	admin_user_ids: Optional[List[List[str]]]
	"""pointer to HR Location object (reference to HrisLocation)"""
	location_id: Optional[str]
	has_antivirus: Optional[bool]
	has_password_manager: Optional[bool]
	has_firewall: Optional[bool]
	has_hd_encrypted: Optional[bool]
	has_screenlock: Optional[bool]
	is_missing: Optional[bool]
	metadata: Optional[PropertyHrisDeviceMetadata]
Are we missing anything? Let us know
Was this page helpful?