Appearance

List Bgv packages ​

Endpoint ​

http
GET /unified/hris/bgv_packages
Integrations supported
  • SpringVerify India

Query parameters ​

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · 

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string

The format of the response.

  • unified returns the response with unified mappings applied.
  • raw returns the unprocessed, raw response from the remote API.
  • normalized applies the unified mappings and returns the data in a normalized format.
  • stream returns the response as a stream, which is ideal for transmitting large datasets, files, or binary data. Using streaming mode helps to efficiently handle large payloads or real-time data flows without requiring the entire data to be buffered in memory.
  • debug returns the final unified result alongside raw remote fetch information. The response is an envelope containing result (identical to unified mode output) and debug (with requestUrl, requestOptions, data, responseHeaders, and for list operations: nextCursor, isLooping, isEmptyResult, resultCount). debug is null for static responses or when truto_skip_api_call=true.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
  • stream
  • debug
Example: unified
truto_key_by
string

By default the result attribute is an array of objects. This parameter allows you to specify a field in each result objects to use as key, which transforms the result array into an object with the array items keyed by the field. This is useful for when you want to use the result as a lookup table.

Example: id
truto_ignore_limit
boolean

Ignores the limit query parameter.

truto_ignore_remote_data
boolean

Excludes the remote_data attribute from the response.

truto_exclude_fields
array

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar

Response Body ​

result
object[]

List of Bgv packages

id
string
REQUIRED · 

The BGV package's unique identifier

Supported in
  • SpringVerify India
name
string

The BGV package's name

Supported in
  • SpringVerify India
description
string

The BGV package's description

Supported in
  • SpringVerify India
checks
object[]

The BGV package's checks

Supported in
  • SpringVerify India
id
string

The check's unique identifier

name
string

The check's name

type
string

The check's type

description
string

The check's description

created_at
string · date-time

The date and time of the BGV package's creation

Supported in
  • SpringVerify India
updated_at
string · date-time

The date and time of the BGV package's last update

Supported in
  • SpringVerify India
package_group
object

The BGV package's package group

Supported in
  • SpringVerify India
id
string

The package group's unique identifier

name
string

The package group's name

etag
string

The unique identifier for the specific version of the resource

remote_data
object

Raw data returned from the remote API call.

next_cursor
string

The cursor to use for the next page of results. Pass this value as next_cursor in the query parameter in the next request to get the next page of results.

debug
object

Present only when truto_response_format=debug. Contains raw fetch details: requestUrl, requestOptions, data, responseHeaders, nextCursor, isLooping, isEmptyResult, resultCount. null for static responses or when truto_skip_api_call=true.

requestUrl
string
requestOptions
object
data
responseHeaders
object
nextCursor
string
isLooping
boolean
isEmptyResult
boolean
resultCount
number