Filtering and pagination | HIS User documentation

ICAP list operations return a paged result. Always page through a collection instead of assuming that the first response is complete.

GET /identity?offset=0&limit=100

The response includes items, offset, limit, and total. Begin at offset 0, advance by the number of items received, and stop when the returned collection is exhausted. Do not rely solely on total while the underlying data can change.

Useful list filters

Resource	Filters in addition to paging	Use case
Identities and visitors	`externalIds`, `updatedSince`	Reconcile a business system or process recent changes.
Visits	`externalIds`, `updatedSince`	Find a visit or process recent changes.
Visitor visits and visit participants	`status`	Work with planned, checked-in, or checked-out attendance.
Credentials	`externalIds`, `updatedSince`; card credentials also support `cardTypeId` and `eligibleFor`	Locate a credential or select eligible credentials.
Access units and card types	`pacsId` or `eligibleFor`, as applicable	Select usable targets or types for a recipient/PACS.
PACS transactions	`pacsId`, `entityId`, `relatedEntityId`, `operation`	Investigate downstream work.
Personal shares	`status`, `updatedSince`, `contractId`, `correlationId`	Manage a share queue or trace a business request.

External IDs and incremental reads

externalIds is a value-oriented lookup. For identities, visitors, and visits, matching external-ID values uses OR semantics across the supplied values and does not restrict the provider key. Validate the returned externalIds before acting on a record.

Use updatedSince for an incremental feed, but make your consumer idempotent: records can be updated while pages are being read, and a successful event in your system should be safe to process again.

Keep photos off bulk reads by default

Identity, visitor, and personal-share list/get endpoints omit photos unless use the query param includePhoto=true. This reduces payload size and unnecessary handling of personal data. Fetch photos only where the calling workflow needs them.

Each endpoint's precise parameters, enum values, and defaults are specified in the API reference.