HIVE Docs
Explore HIVE

List parameters

Every list operation accepts limit, cursor, sort, fields, count and, when it declares expansions, expand (guide: pagination.en.md, pagination.de.md). The filters below come from x-hive-filterable on the properties of the listed resource.

api_key_list (GET /v1/api-keys)#

Default sort -created_at.

ParameterDescription
limitPage size, 1 to 500 (default 50).
cursorOpaque cursor from next_cursor of the previous page.
sortComma separated sortable fields, a leading - sorts descending; default -created_at.
fieldsComma separated top-level fields to return (id and object are always returned).
counttrue adds total_count (exact up to 10,000).
service_account_idFilter service_account_id: reference eq.

asset_list (GET /v1/assets)#

Default sort sort_order.

ParameterDescription
limitPage size, 1 to 500 (default 50).
cursorOpaque cursor from next_cursor of the previous page.
sortComma separated sortable fields, a leading - sorts descending; default sort_order.
fieldsComma separated top-level fields to return (id and object are always returned).
counttrue adds total_count (exact up to 10,000).
asset_type_idFilter asset_type_id: reference eq.
asset_type_id[in]Filter asset_type_id: reference in.
asset_type_id[is_null]Filter asset_type_id: reference is_null.
keyFilter key: string eq.
key[prefix]Filter key: string prefix.
kindFilter kind: enum eq.
kind[in]Filter kind: enum in.
lifecycle_stateFilter lifecycle_state: enum eq.
lifecycle_state[in]Filter lifecycle_state: enum in.
parent_idFilter parent_id: reference eq.
parent_id[in]Filter parent_id: reference in.
parent_id[is_null]Filter parent_id: reference is_null.
site_idFilter site_id: reference eq.
site_id[in]Filter site_id: reference in.

asset_get_children (GET /v1/assets/{id}/children)#

Default sort sort_order.

ParameterDescription
limitPage size, 1 to 500 (default 50).
cursorOpaque cursor from next_cursor of the previous page.
sortComma separated sortable fields, a leading - sorts descending; default sort_order.
fieldsComma separated top-level fields to return (id and object are always returned).
counttrue adds total_count (exact up to 10,000).
asset_type_idFilter asset_type_id: reference eq.
asset_type_id[in]Filter asset_type_id: reference in.
asset_type_id[is_null]Filter asset_type_id: reference is_null.
keyFilter key: string eq.
key[prefix]Filter key: string prefix.
kindFilter kind: enum eq.
kind[in]Filter kind: enum in.
lifecycle_stateFilter lifecycle_state: enum eq.
lifecycle_state[in]Filter lifecycle_state: enum in.
parent_idFilter parent_id: reference eq.
parent_id[in]Filter parent_id: reference in.
parent_id[is_null]Filter parent_id: reference is_null.
site_idFilter site_id: reference eq.
site_id[in]Filter site_id: reference in.

asset_get_descendants (GET /v1/assets/{id}/descendants)#

Default sort sort_order.

ParameterDescription
limitPage size, 1 to 500 (default 50).
cursorOpaque cursor from next_cursor of the previous page.
sortComma separated sortable fields, a leading - sorts descending; default sort_order.
fieldsComma separated top-level fields to return (id and object are always returned).
counttrue adds total_count (exact up to 10,000).
asset_type_idFilter asset_type_id: reference eq.
asset_type_id[in]Filter asset_type_id: reference in.
asset_type_id[is_null]Filter asset_type_id: reference is_null.
keyFilter key: string eq.
key[prefix]Filter key: string prefix.
kindFilter kind: enum eq.
kind[in]Filter kind: enum in.
lifecycle_stateFilter lifecycle_state: enum eq.
lifecycle_state[in]Filter lifecycle_state: enum in.
parent_idFilter parent_id: reference eq.
parent_id[in]Filter parent_id: reference in.
parent_id[is_null]Filter parent_id: reference is_null.
site_idFilter site_id: reference eq.
site_id[in]Filter site_id: reference in.

clock_status_list (GET /v1/clock-statuses)#

Default sort -state_since.

ParameterDescription
limitPage size, 1 to 500 (default 50).
cursorOpaque cursor from next_cursor of the previous page.
sortComma separated sortable fields, a leading - sorts descending; default -state_since.
fieldsComma separated top-level fields to return (id and object are always returned).
counttrue adds total_count (exact up to 10,000).
source_kindFilter source_kind: enum eq.
source_kind[in]Filter source_kind: enum in.
stateFilter state: enum eq.
state[in]Filter state: enum in.

clock_status_get_exceptions (GET /v1/clock-statuses/{id}/exceptions)#

Default sort -t_ingest.

ParameterDescription
limitPage size, 1 to 500 (default 50).
cursorOpaque cursor from next_cursor of the previous page.
sortComma separated sortable fields, a leading - sorts descending; default -t_ingest.
fieldsComma separated top-level fields to return (id and object are always returned).
counttrue adds total_count (exact up to 10,000).

membership_list (GET /v1/memberships)#

Default sort -created_at.

ParameterDescription
limitPage size, 1 to 500 (default 50).
cursorOpaque cursor from next_cursor of the previous page.
sortComma separated sortable fields, a leading - sorts descending; default -created_at.
fieldsComma separated top-level fields to return (id and object are always returned).
counttrue adds total_count (exact up to 10,000).
statusFilter status: enum eq.
status[in]Filter status: enum in.

service_account_list (GET /v1/service-accounts)#

Default sort -created_at.

ParameterDescription
limitPage size, 1 to 500 (default 50).
cursorOpaque cursor from next_cursor of the previous page.
sortComma separated sortable fields, a leading - sorts descending; default -created_at.
fieldsComma separated top-level fields to return (id and object are always returned).
counttrue adds total_count (exact up to 10,000).