Managry logo
API docs by Redocly

Managry API (1.105.0+67)

Download OpenAPI specification:

Managry Support: support@managry.com URL: https://managry.com/support/ License: MIT

Managry API handles the management of time, attendance, and expenses. It's a backend service for the Current Timesheets and Traverse applications.

Authentication

Authentication is the process of verifying the identity of a user. This process is necessary to ensure that the user is who they claim to be.

Authenticate user

Authenticates a user with email and password and returns a Firebase ID token (idToken) for subsequent authenticated API requests.

Use this token in the Authorization header for protected endpoints: Authorization: Bearer <idToken>.

Request Body schema: application/json
required

User email and password credentials

email
required
string
password
required
string

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "idToken": "string"
}

Commands

Commands are the primary way to interact with the system. All changes to the system, including entities, are made through commands.

Apply a command

This endpoint receives a command and applies it to the system.

There are many types of commands, each with its own set of parameters. The command type is specified in the mime type of the request. Therefore, the endpoint supports many mime types. The command parameters are specified in the request body.

Authorizations:
Bearer
header Parameters
Accept
string

Specifies the media types that the client can process. The server will respond with content in one of these types if possible.

If none of the provided MIME types are supported by the server, it will return a 405 Unsupported Media Type response.

Request Body schema:
required
dateTime
required
string <date-time>

The time when the command was created. This is the local time on the device in UTC format. It might differ from server time.

audioRecordId
required
string <uuid>
blobId
required
string <uuid>
userId
required
string <uuid>
duration
required
integer <int64>

Responses

Request samples

Content type
{
  • "dateTime": "2019-08-24T14:15:22Z",
  • "audioRecordId": "ccf44280-6216-4de1-a6db-82d91a3891c5",
  • "blobId": "0f49f85e-7d44-46b5-bdff-ecf86c7fc0da",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "duration": 0
}

Response samples

Content type
[
  • {
    }
]

Entities

Entities are the primary way to interact with the system. All data in the system is stored in entities. Entities are created, updated, and deleted through commands.

List entity metadata

Returns metadata for entities of the requested type.

The result is paginated and sorted by serverTime in ascending order. Query parameters:

  • pageSize defaults to 100.
  • pageNumber defaults to 0.

The endpoint returns metadata only (entityType, id, serverTime), not full entity payloads.

Authorizations:
Bearer
path Parameters
entityName
required
string
Enum: "AttendanceTenant" "AttendanceUser"

Name of the entity to retrieve.

query Parameters
pageSize
integer <int32> [ 1 .. 500 ]
Default: 100

Number of items to return in one page.

pageNumber
integer <int32> [ 0 .. 1000000 ]
Default: 0

Zero-based page index.

header Parameters
Accept
string

Specifies the media types that the client can process. The server will respond with content in one of these types if possible.

If none of the provided MIME types are supported by the server, it will return a 405 Unsupported Media Type response.

Responses

Response samples

Content type
[
  • {
    }
]

Get entity

Get an entity by its ID.

Authorizations:
Bearer
path Parameters
entityName
required
string
Enum: "AttendanceTenant" "AttendanceUser"

Name of the entity to retrieve.

entityId
required
string

The id of the entity to retrieve

header Parameters
Accept
string

Specifies the media types that the client can process. The server will respond with content in one of these types if possible.

If none of the provided MIME types are supported by the server, it will return a 405 Unsupported Media Type response.

Request Body schema: application/json
Schema not provided

Responses

Response samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "createTime": "2019-08-24T14:15:22Z",
  • "updateTime": "2019-08-24T14:15:22Z",
  • "serverTime": "2019-08-24T14:15:22Z",
  • "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
  • "clockInPhotoRequired": true,
  • "clockOutPhotoRequired": true,
  • "clockInOutLocationStored": true,
  • "autoArchiveExpenseGroups": true,
  • "autoArchiveExpenseGroupDayCount": 0,
  • "stableHashCode": 0
}