Skip to content
Platform Usage APIs
/
/Login History API/
List Login History

List Login History

Request

Login History events can be filtered by specifying a date interval.
Maximum number of events that will be received by page is 200.
The OAuth 2.0 scope to use is team.login-history:read.
If there would be more events on the specified date interval total number of pages will be returned for further querying.

Security
Authorization
Query
pageNumberinteger, (int32), >= 0

Page number to be retrieved, starts with 0

Default:0
Example:pageNumber=0
pageSizeinteger, (int32), [ 1 .. 200 ]

Limit of results per page

Default:200
Example:pageSize=200
fromstring, (date-time)

Date Time ISO 8601 yyyy-MM-ddTHH:mm:ss

Example:from=2022-01-01T09:00:00
tostring, (date-time)

Date Time ISO 8601 yyyy-MM-ddTHH:mm:ss

Example:to=2022-01-31T09:00:00
GET
/api/external/authentication-events
curl -i -X GET \
  'https://developer.celonis.com/_mock/celonis-apis/team-api/openapi/openapi/api/external/authentication-events?pageNumber=0&pageSize=200&from=2022-01-01T09%3A00%3A00&to=2022-01-31T09%3A00%3A00' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

A list of Login History events

Bodyapplication/json
contentArray of objects(AuthenticationEventExternalTransport)
pageNumberinteger, (int32)
pageSizeinteger, (int32)
totalCountinteger, (int64)
Response
{
  "content": [
    {
      "authenticationEventType": "LOGIN",
      "email": "email@example.com",
      "success": true,
      "timestamp": "2021-01-08T16:36:29.003Z"
    }
  ],
  "pageNumber": 0,
  "pageSize": 0,
  "totalCount": 0
}