time-tracking-timestamps

Manage time tracking timestamps

Operations

POST/accounts/{accountUuid}/time/v2/employees/{employeeUuid}/in-outGET/accounts/{accountUuid}/time/v2/employees/{employeeUuid}/in-out/{inOutUuid}DELETE/accounts/{accountUuid}/time/v2/employees/{employeeUuid}/in-out/{inOutUuid}PATCH/accounts/{accountUuid}/time/v2/employees/{employeeUuid}/in-out/{inOutUuid}GET/accounts/{accountUuid}/time/v2/employees/{employeeUuid}/in-out/currently-openGET/accounts/{accountUuid}/time/v2/employees/{employeeUuid}/in-out/open-daysPOST/accounts/{accountUuid}/time/v2/employees/{employeeUuid}/in-out/timestamp-event

---

Add timestamp

POST

/accounts/{accountUuid}/time/v2/employees/{employeeUuid}/in-out

Add a timestamp for an employee

Authorizations

ApiToken

Bearer token authentication. Create tokens in Settings > API Token.

Type

HTTP (bearer)

Parameters

Path Parameters

accountUuid*

Type

string

Required

Format

"uuid"

employeeUuid*

Type

string

Required

Format

"uuid"

Request Body

application/json

{

  

"date": "string",

  

"startTime": "string",

  

"endTime": "string",

  

"comment": "string",

  

"device": "string"

}

Responses

Successful response

Content-Type

application/json

{

  

"data": {

  

  

"uuid": "string",

  

  

"date": "string",

  

  

"startTime": "string",

  

  

"endTime": "string",

  

  

"startDateTime": "2024-01-14T20:20:00",

  

  

"endDateTime": "2024-01-14T21:00:00",

  

  

"startDevice": "string",

  

  

"endDevice": "string",

  

  

"type": "string",

  

  

"comment": "string",

  

  

"isClosed": true,

  

  

"closedAt": "string",

  

  

"closedAtDateTime": "2024-01-31T13:00:00",

  

  

"duration": {

  

  

  

"hours": "string",

  

  

  

"minutes": "string"

  

  

},

  

  

"createdAt": "string",

  

  

"updatedAt": "string"

  

},

  

"message": "string",

  

"status": 201,

  

"meta": {

  

}

}

POST

/accounts/{accountUuid}/time/v2/employees/{employeeUuid}/in-out

Playground

Authorization

ApiToken

Variables

Key

Value

accountUuid*

employeeUuid*

Body

Samples

---

Get timestamp

GET

/accounts/{accountUuid}/time/v2/employees/{employeeUuid}/in-out/{inOutUuid}

Get the timestamp of an employee

Authorizations

ApiToken

Bearer token authentication. Create tokens in Settings > API Token.

Type

HTTP (bearer)

Parameters

Path Parameters

accountUuid*

Type

string

Required

Format

"uuid"

employeeUuid*

Type

string

Required

Format

"uuid"

inOutUuid*

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

{

  

"data": {

  

  

"uuid": "string",

  

  

"date": "string",

  

  

"startTime": "string",

  

  

"endTime": "string",

  

  

"startDateTime": "2024-01-14T20:20:00",

  

  

"endDateTime": "2024-01-14T21:00:00",

  

  

"startDevice": "string",

  

  

"endDevice": "string",

  

  

"type": "string",

  

  

"comment": "string",

  

  

"isClosed": true,

  

  

"closedAt": "string",

  

  

"closedAtDateTime": "2024-01-31T13:00:00",

  

  

"duration": {

  

  

  

"hours": "string",

  

  

  

"minutes": "string"

  

  

},

  

  

"createdAt": "string",

  

  

"updatedAt": "string"

  

},

  

"message": "string",

  

"status": 200,

  

"meta": {

  

}

}

GET

/accounts/{accountUuid}/time/v2/employees/{employeeUuid}/in-out/{inOutUuid}

Playground

Authorization

ApiToken

Variables

Key

Value

accountUuid*

employeeUuid*

inOutUuid*

Samples

---

Delete timestamp

DELETE

/accounts/{accountUuid}/time/v2/employees/{employeeUuid}/in-out/{inOutUuid}

Delete a timestamp for an employee

Authorizations

ApiToken

Bearer token authentication. Create tokens in Settings > API Token.

Type

HTTP (bearer)

Parameters

Path Parameters

accountUuid*

Type

string

Required

Format

"uuid"

employeeUuid*

Type

string

Required

Format

"uuid"

inOutUuid*

Type

string

Required

Format

"uuid"

Responses

Successful response

DELETE

/accounts/{accountUuid}/time/v2/employees/{employeeUuid}/in-out/{inOutUuid}

Playground

Authorization

ApiToken

Variables

Key

Value

accountUuid*

employeeUuid*

inOutUuid*

Samples

---

Update timestamp

PATCH

/accounts/{accountUuid}/time/v2/employees/{employeeUuid}/in-out/{inOutUuid}

Update a timestamp for an employee

Authorizations

ApiToken

Bearer token authentication. Create tokens in Settings > API Token.

Type

HTTP (bearer)

Parameters

Path Parameters

accountUuid*

Type

string

Required

Format

"uuid"

employeeUuid*

Type

string

Required

Format

"uuid"

inOutUuid*

Type

string

Required

Format

"uuid"

Request Body

application/json

{

  

"date": "string",

  

"startTime": "string",

  

"endTime": "string",

  

"comment": "string",

  

"device": "string"

}

Responses

Successful response

Content-Type

application/json

{

  

"data": {

  

  

"uuid": "string",

  

  

"date": "string",

  

  

"startTime": "string",

  

  

"endTime": "string",

  

  

"startDateTime": "2024-01-14T20:20:00",

  

  

"endDateTime": "2024-01-14T21:00:00",

  

  

"startDevice": "string",

  

  

"endDevice": "string",

  

  

"type": "string",

  

  

"comment": "string",

  

  

"isClosed": true,

  

  

"closedAt": "string",

  

  

"closedAtDateTime": "2024-01-31T13:00:00",

  

  

"duration": {

  

  

  

"hours": "string",

  

  

  

"minutes": "string"

  

  

},

  

  

"createdAt": "string",

  

  

"updatedAt": "string"

  

},

  

"message": "string",

  

"status": 200,

  

"meta": {

  

}

}

PATCH

/accounts/{accountUuid}/time/v2/employees/{employeeUuid}/in-out/{inOutUuid}

Playground

Authorization

ApiToken

Variables

Key

Value

accountUuid*

employeeUuid*

inOutUuid*

Body

Samples

---

Get currently open timestamp

GET

/accounts/{accountUuid}/time/v2/employees/{employeeUuid}/in-out/currently-open

Get the relevant currently open timestamp of an employee

Authorizations

ApiToken

Bearer token authentication. Create tokens in Settings > API Token.

Type

HTTP (bearer)

Parameters

Path Parameters

accountUuid*

Type

string

Required

Format

"uuid"

employeeUuid*

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

{

  

"data": {

  

  

"uuid": "string",

  

  

"date": "string",

  

  

"startTime": "string",

  

  

"endTime": "string",

  

  

"startDateTime": "2024-01-14T20:20:00",

  

  

"endDateTime": "2024-01-14T21:00:00",

  

  

"startDevice": "string",

  

  

"endDevice": "string",

  

  

"type": "string",

  

  

"comment": "string",

  

  

"isClosed": true,

  

  

"closedAt": "string",

  

  

"closedAtDateTime": "2024-01-31T13:00:00",

  

  

"duration": {

  

  

  

"hours": "string",

  

  

  

"minutes": "string"

  

  

},

  

  

"createdAt": "string",

  

  

"updatedAt": "string"

  

},

  

"message": "string",

  

"status": 200,

  

"meta": {

  

}

}

GET

/accounts/{accountUuid}/time/v2/employees/{employeeUuid}/in-out/currently-open

Playground

Authorization

ApiToken

Variables

Key

Value

accountUuid*

employeeUuid*

Samples

---

Get past days with open timestamps

GET

/accounts/{accountUuid}/time/v2/employees/{employeeUuid}/in-out/open-days

Get past days of an employee that have open timestamps

Authorizations

ApiToken

Bearer token authentication. Create tokens in Settings > API Token.

Type

HTTP (bearer)

Parameters

Path Parameters

accountUuid*

Type

string

Required

Format

"uuid"

employeeUuid*

Type

string

Required

Format

"uuid"

Query Parameters

date

Type

[ "string", "null" ]

Format

"date"

Default

null

Responses

Successful response

Content-Type

application/json

{

  

"data": [

  

  

"string"

  

],

  

"message": "string",

  

"status": 200,

  

"meta": {

  

}

}

GET

/accounts/{accountUuid}/time/v2/employees/{employeeUuid}/in-out/open-days

Playground

Authorization

ApiToken

Variables

Key

Value

accountUuid*

employeeUuid*

date

Samples

---

Add timestamp event

POST

/accounts/{accountUuid}/time/v2/employees/{employeeUuid}/in-out/timestamp-event

Process a start or stop timestamp event

Authorizations

ApiToken

Bearer token authentication. Create tokens in Settings > API Token.

Type

HTTP (bearer)

Parameters

Path Parameters

accountUuid*

Type

string

Required

Format

"uuid"

employeeUuid*

Type

string

Required

Format

"uuid"

Request Body

application/json

{

  

"dateTime": "2024-01-14T20:20:00",

  

"eventType": "string",

  

"device": "string"

}

Responses

Successfully processed

Content-Type

application/json

{

  

"data": {

  

  

"uuid": "string",

  

  

"date": "string",

  

  

"startTime": "string",

  

  

"endTime": "string",

  

  

"startDateTime": "2024-01-14T20:20:00",

  

  

"endDateTime": "2024-01-14T21:00:00",

  

  

"startDevice": "string",

  

  

"endDevice": "string",

  

  

"type": "string",

  

  

"comment": "string",

  

  

"isClosed": true,

  

  

"closedAt": "string",

  

  

"closedAtDateTime": "2024-01-31T13:00:00",

  

  

"duration": {

  

  

  

"hours": "string",

  

  

  

"minutes": "string"

  

  

},

  

  

"createdAt": "string",

  

  

"updatedAt": "string"

  

},

  

"message": "string",

  

"status": 200,

  

"meta": {

  

}

}

POST

/accounts/{accountUuid}/time/v2/employees/{employeeUuid}/in-out/timestamp-event

Playground

Authorization

ApiToken

Variables

Key

Value

accountUuid*

employeeUuid*

Body

Samples

---