Get Entries

Description

Allows you to obtain a list of entries registered at the branch.

NOTE. When the start date and end date are not provided, the system will always consider the current day of the query. Additionally, you can specify only registerDateStart, and the system will consider from that date until the current day.

🔑 Query Parameters

This endpoint supports optional filters through query parameters to refine the results.

Parameter	Type	Required	Description
`registerDateStart`	date-time	No	Start date of the entry in ISO 8601 format (`YYYY-MM-DDTHH:mm:ssZ`). When provided alone, filters from the specified date to the current date.
`registerDateEnd`	date-time	No	End date of the entry in ISO 8601 format (`YYYY-MM-DDTHH:mm:ssZ`).
`take`	int32	No	Total number of records to be returned. Default value is `50`. Maximum allowed: `1000`.
`skip`	int32	No	Total number of records to be skipped. Default value is `0`.
`idEntry`	int32	No	Unique ID of the entry to be returned.
`idMember`	int32	No	ID of the member to be returned.
`idProspect`	int32	No	ID of the prospect to be returned.
`idEmployee`	int32	No	ID of the employee to be returned.

📤 Response Structure

Field	Type	Description
`date`	string	Date/time of the entry registration.
`dateTurn`	string(date-time)	Date/time corresponding to the shift of the entry.
`timeZone`	string	Time zone associated with the registration.
`idMember`	int32	Identifier of the member (if the entry is for a student).
`nameMember`	string	Name of the member.
`idProspect`	int32	Identifier of the prospect (if the entry is for a visitor/prospect).
`nameProspect`	string	Name of the prospect.
`idEmployee`	int32	Identifier of the staff member (if the entry is for an employee).
`nameEmployee`	string	Name of the staff member.
`entryType`	string	Type of entry (e.g., biometrics, QR Code, manual, etc.).
`device`	string	Device used to register the entry.
`releasesByID`	int32	Identifier of the release associated (if applicable).
`idBranch`	int32	Identifier of the branch where the entry occurred.
`blockReason`	string	Reason for the block, if the entry was blocked.
`entryAction`	string	Action associated with the entry (e.g., released, blocked, attempt).
`idMigration`	string	Migration identifier, when the entry is related to migration processes.
`idTurnstile`	int32	Identifier of the turnstile associated with the entry.

Basic Auth

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string username:password

Example:

Authorization: Basic *****************

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Success

Body

Example

[
    {
        "date": "2019-08-24T14:15:22.123Z",
        "dateTurn": "2019-08-24T14:15:22.123Z",
        "timeZone": "string",
        "idMember": 0,
        "nameMember": "string",
        "idProspect": 0,
        "nameProspect": "string",
        "idEmployee": 0,
        "nameEmployee": "string",
        "entryType": "string",
        "device": "string",
        "releasesByID": 0,
        "idBranch": 0,
        "blockReason": "string",
        "entryAction": "string",
        "idMigration": "string",
        "idTurnstile": 0
    }
]

🟠400Bad Request

Get entries

Get Entries#

Description#

🔑 Query Parameters#