KEkeka
BGVRequest

Get all bgvrequests

Get all bgvrequests

get/hris/bgv/{bgvId}/requests

Request

  • Base URL
    https://{company}.keka.com/api/v1
  • URL
    https://{company}.keka.com/api/v1/hris/bgv/{bgvId}/requests
  • Auth
    OAuth 2
    Implicit: https://login.keka.com/connect/authorize

Path parameters

bgvIdstring required

The BGV identifier.

Query parameters

bgvRequestIdsstring

The BGV request ids.

candidateIdsstring

The candidate ids.

bgvStatusstring

The BGV status.

lastModifiedstring date-time

The last modified.

pageNumberinteger
pageSizeinteger

Represents how many results you'd like to retrieve per request (page). Default is 100. Max is 200

Response

OK

succeededboolean

Gets or sets a value indicating whether this Keka.API.Web.Core.Response`1 is succeeded.

messagestring nullable

Gets or sets the message.

errorsstring[] nullable

Gets or sets the errors.

pageNumberinteger

Gets or sets the page number.

pageSizeinteger

Gets or sets the size of the page.

firstPagestring uri nullable

Gets or sets the first page.

lastPagestring uri nullable

Gets or sets the last page.

totalPagesinteger

Gets or sets the total pages.

totalRecordsinteger

Gets or sets the total records.

nextPagestring uri nullable

Gets or sets the next page.

previousPagestring uri nullable

Gets or sets the previous page.

Changes

No recorded changes to this operation across all 1 revision of this API.