What the API sends.

Every field a key can return, listed. Which of them you can switch off, which you cannot, and which nobody can read at all.

Start here

Manifest has a REST API so your own systems can read the register. A key is issued in the app, and it reaches one thing: your assets.

  • Three routes. List assets, fetch one asset, upsert assets. That is all of it.
  • Nothing else is reachable. No users, no audit trail, no attachments, no contracts. Not restricted for your key — not built.
  • Reads only your register. The organisation comes from the key itself and is never read from the request, so a key cannot be pointed at anybody else’s fleet.

What a key can never read

This half is not a permission and there is no setting for it.

Held backWhat it is
Regulated dataWhether a device is in scope for cardholder data, health records, controlled unclassified information or EU personal data
Disposal evidenceThe witness, the wipe certificate, who authorised it, how it was sanitised
Condition notesWhat a technician wrote about the machine
Lease paymentsWhat a leased device costs per month
Key escrowWhether a recovery key is held by somebody other than the owner
Photographs and attachmentsEvery file on a record

These are encrypted on your device with a key we never receive. We could only ever hand an integration the encrypted bytes, which are of no use to it. So there is no switch: the field names are not on the list the database will accept, and a key asking for one is refused before the request reaches your data.

Every field a key can read: 39 of them

The left column is the name you will see in the JSON. Everything here can be switched off for a given key except the first four.

The record itself

FieldWhat it is
idRecord id
seq_idChange cursor
updated_atLast changed
is_deletedRemoved

Identity

FieldWhat it is
asset_tagAsset tag
serial_numberSerial number
makeMake
modelModel
asset_typeType

People

FieldWhat it is
assigned_user_idHolder's id
assigned_user_nameHolder's name
departmentDepartment

Where it is

FieldWhat it is
location_siteSite
site_idSite id
stockroom_idStockroom id

Condition

FieldWhat it is
statusStatus
status_changed_atStatus changed
criticalityCriticality
flagged_for_auditFlagged
last_audited_atLast verified
has_obligationsCarries regulated data

Dates

FieldWhat it is
install_dateInstalled
purchase_datePurchased
warranty_expiration_dateWarranty expires
refresh_target_dateRefresh due

Money and supplier

FieldWhat it is
purchase_pricePurchase price
acquisition_typeHow it was acquired
vendorVendor
purchase_order_numberPO number
ownershipOwnership

Network and disk

FieldWhat it is
hostnameHostname
mac_addressMAC address
ip_addressIP address
encryption_statusDisk encryption
encryption_methodEncryption method
data_classificationClassification

Where the row came from

FieldWhat it is
external_idYour own id
external_sourceWhich system sent it
external_modified_atWhen that system changed it

The first four always travel. seq_id is the cursor your system follows changes with, id is how a record is addressed, and updated_at and is_deleted are how you know what changed and what went away. A key without them returns pages that cannot be followed, so they are shown locked rather than offered and then quietly put back.

The two worth thinking about are People and Network. The first names a person; if the system holding the key is not yours, that is personal data crossing a boundary. The second is a map of your estate: useful to a scanner, and useful to anything else.

How a key is configured

In the app, under Settings, API access. Only an owner can issue one or change what it reaches.

PresetSendsWhen
Everything readableAll 39 fields.The default. Fine when the system holding the key is yours.
Nothing about people36 fields.Drops the holder's name, their id and their department. This is the one to use when the other system belongs to somebody else.
Hardware only25 fields.Tags, serials, models, status, dates and location. No people, no prices, no network addresses.
Choose fieldsAny subset.Every field is a switch, except the four the record cannot be read without.
  • Chosen when the key is issued. Issuing a key that reads everything and narrowing it afterwards is not the same thing: the first call to the change feed returns your whole register.
  • Changing it later works, with one limit. Switching a field off stops it being sent from that key’s next request onward. It does not reach into the other system and remove what it already pulled.
  • A key cannot write what it cannot read. Send a field outside its scope and the whole batch is refused, naming the field — rather than the field being dropped and the request reported as a success.

The other limits on a key

  • Shown once. We keep only a fingerprint, so we cannot show it to you again — only replace it.
  • A year, then it stops. You renew from the app. The key nobody has thought about for four years is the one that gets left behind.
  • 120 requests a minute.
  • Read, or read and write. Separate from the field list: one is what it may do, the other is what it may see.
  • Revocable, and never deleted. A revoked key stays in the list so the trail entries it wrote still resolve to a name.

More on where your register lives and what we can read is on the security page.