API docs by Redocly

Tomotime API (1.0)

Download OpenAPI specification:Download

Jimmy: jimmy@tomotime.app

Core Tomotime API

notifications

AdminNotifyGroupsHandler

Handler to help notify a group via push notifications

Request Body schema: application/json
required

request object

allGroups
boolean

this controls if we should notify all groups or just groupId

object
groupId
string

this is only used if allGroups is false

memoryId
string

this is used if onlyMissing is true

message
string
onlyMissing
boolean

this controls if we should only notif those who have not responded

password
string
title
string

Responses

Request samples

Content type
application/json
{
  • "allGroups": true,
  • "data": { },
  • "groupId": "string",
  • "memoryId": "string",
  • "message": "string",
  • "onlyMissing": true,
  • "password": "string",
  • "title": "string"
}

Response samples

Content type
application/json
"string"

MarkAllAsSeen

Marks all notifications as seen for a user

Responses

Response samples

Content type
application/json
"string"

RegisterNotifHandler

Registers a new notification token for a user

Request Body schema: application/json
required

request object

device
string
token
string

Responses

Request samples

Content type
application/json
{
  • "device": "string",
  • "token": "string"
}

Response samples

Content type
application/json
"string"

GetSeenNotifications

Gets all seen notifications for a user

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": "string",
  • "success": true
}

GetUnseenNotifications

Gets all unseen notifications for a user

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": "string",
  • "success": true
}

feat-flag

GetFeatFlagStatus

Gets a feature flag and determines whether it is enabled or disabled globally; default - false

query Parameters
flag
required
string

feature flag to determine status of

Responses

Response samples

Content type
application/json
{
  • "data": true,
  • "error": "string",
  • "success": true
}

groups

GetGroupPublicInfoHandler

Handle users joining a group via invite link

Request Body schema: application/json
required

request object

groupId
string

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": "string",
  • "success": true
}

UpdateGroupName

Updates the name of a group

Request Body schema: application/json
required

request object

groupId
required
string
name
required
string

Responses

Request samples

Content type
application/json
{
  • "groupId": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "data": "string",
  • "error": "string",
  • "success": true
}

GetGroupActivityHandler

GetGroupActivityHandler is the handler for getting activity information about a group

path Parameters
id
required
string

group id to get activity for

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": "string",
  • "success": true
}

replies

GetMemoryReplies Deprecated

Gets all replies for a memory

path Parameters
id
required
string

memory id to get all replies for

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": "string",
  • "success": true
}

AddMemoryReply Deprecated

Add a reply to a memory

path Parameters
id
required
string

memory id to insert reply for

Request Body schema: application/json
required

request object

memoryId
string
message
string

Responses

Request samples

Content type
application/json
{
  • "memoryId": "string",
  • "message": "string"
}

Response samples

Content type
application/json
{
  • "data": "string",
  • "error": "string",
  • "success": true
}

GetMemoryRepliesV2

Gets all replies for a memory

path Parameters
id
required
string

memory id to get all replies for

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": "string",
  • "success": true
}

AddMemoryReplyV2

Add a reply to a memory

path Parameters
id
required
string

memory id to insert reply for

Request Body schema: application/json
required

request object

memoryId
string
message
string
promptNumber
integer
targetUserId
string

Responses

Request samples

Content type
application/json
{
  • "memoryId": "string",
  • "message": "string",
  • "promptNumber": 0,
  • "targetUserId": "string"
}

Response samples

Content type
application/json
{
  • "data": "string",
  • "error": "string",
  • "success": true
}

memories

GetMemoryInfo

Gets all information and metadata for a memory

Request Body schema: application/json
required

request object

memoryId
string

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": "string",
  • "success": true
}

MemoryResponse

Handles a user responding to a memory and stores their reply

Request Body schema: application/json
required

request object

memoryId
string
Array of objects (coredb.PromptResponse)

Responses

Request samples

Content type
application/json
{
  • "memoryId": "string",
  • "responses": [
    ]
}

Response samples

Content type
application/json
{
  • "data": "string",
  • "error": "string",
  • "success": true
}

MemoryResponseV2 which validates response

Handles a user responding to a memory and stores their reply

Request Body schema: application/json
required

request object

memoryId
string
Array of objects (coredb.PromptResponse)

Responses

Request samples

Content type
application/json
{
  • "memoryId": "string",
  • "responses": [
    ]
}

Response samples

Content type
application/json
{
  • "data": "string",
  • "error": "string",
  • "success": true
}

streaks

GetGroupStreakLeaderboard

Gets the at max 5 highest streaks in a group

query Parameters
groupId
required
string

group id to get the user's current streak for

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "error": "string",
  • "success": true
}

GetGroupCurrentStreakLeaderboard

Gets the at max 5 current streaks in a group

query Parameters
groupId
required
string

group id to get the leaderboard for

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "error": "string",
  • "success": true
}

GetUserCurrentStreak

Gets the current memory streak of the requesting user

query Parameters
groupId
required
string

group id to get the user's current streak for

Responses

Response samples

Content type
application/json
{
  • "data": 0,
  • "error": "string",
  • "success": true
}

AdminResetStreaksOnOpen

Resets the streaks for users who have not responded to the last memory for the group, meant to be called on memory open for viewing

query Parameters
groupId
required
string

group id to reset user streaks based off of

Responses

Response samples

Content type
application/json
{
  • "data": "string",
  • "error": "string",
  • "success": true
}

users

DeleteProfile

Handles the deletion of a user profile

Request Body schema: application/json
required

request object

phone
string

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "data": "string",
  • "error": "string",
  • "success": true
}

GetOwnCreatedGroupsHandler

Gets the number of groups created by the user

Responses

Response samples

Content type
application/json
{
  • "data": 0,
  • "error": "string",
  • "success": true
}

admin

AdminInsertGroupActivity

Add group activity message for a group

Request Body schema: application/json
required

request object

groupId
string
message
string
password
string

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "data": "string",
  • "error": "string",
  • "success": true
}

AdminGetGroupWeekHandler

Gets the current week for the group

Responses

Response samples

Content type
application/json
{
  • "data": 0,
  • "error": "string",
  • "success": true
}

questions

AddQuestionHandler

Add question for a group

Request Body schema: application/json
required

request object

anonymous
boolean
groupId
string
questionData
string
questionType
string

Responses

Request samples

Content type
application/json
{
  • "anonymous": true,
  • "groupId": "string",
  • "questionData": "string",
  • "questionType": "string"
}

Response samples

Content type
application/json
{
  • "data": "string",
  • "error": "string",
  • "success": true
}

GetAllQuestions

Gets all questions submitted to a group

Request Body schema: application/json
required

request object

groupId
string

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "error": "string",
  • "success": true
}

SuggestQuestions

Gets a list of suggested questions for a category

query Parameters
type
required
string

type

category
required
string

category

Request Body schema: application/json
required

request object

groupId
string

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "error": "string",
  • "success": true
}

reactions

DeleteMemoryReactionHandler

Delete a reaction from a memory

path Parameters
id
required
string

memory id to insert reaction for

Request Body schema: application/json
required

request object

promptNumber
integer
reaction
string
targetUserId
string

Responses

Request samples

Content type
application/json
{
  • "promptNumber": 0,
  • "reaction": "string",
  • "targetUserId": "string"
}

Response samples

Content type
application/json
{
  • "data": "string",
  • "error": "string",
  • "success": true
}

AddMemoryReaction

Add a reaction to a memory

path Parameters
id
required
string

memory id to insert reaction for

Request Body schema: application/json
required

request object

promptNumber
integer
reaction
string
targetUserId
string

Responses

Request samples

Content type
application/json
{
  • "promptNumber": 0,
  • "reaction": "string",
  • "targetUserId": "string"
}

Response samples

Content type
application/json
{
  • "data": "string",
  • "error": "string",
  • "success": true
}

GetMemoryReactions

Gets all reactions for a memory

path Parameters
id
required
string

memory id to get all replies for

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": "string",
  • "success": true
}

DeleteMemoryReactionHandler

Delete a reaction from a memory

path Parameters
id
required
string

memory id to insert reaction for

Request Body schema: application/json
required

request object

reaction
string

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "data": "string",
  • "error": "string",
  • "success": true
}

AddMemoryReplyReactionHandler

Add a reaction to a memory reply

path Parameters
id
required
string

reply id to insert reaction for

Request Body schema: application/json
required

request object

promptNumber
integer
reaction
string
targetUserId
string

Responses

Request samples

Content type
application/json
{
  • "promptNumber": 0,
  • "reaction": "string",
  • "targetUserId": "string"
}

Response samples

Content type
application/json
{
  • "data": "string",
  • "error": "string",
  • "success": true
}

GetMemoryReactions

Gets all reactions for a memory

path Parameters
id
required
string

memory id to get all replies for

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": "string",
  • "success": true
}

version

GetAndroidVersionHandler

Gets the latest android version

Responses

Response samples

Content type
application/json
"string"

GetIOSVersionHandler

Gets the latest ios version

Responses

Response samples

Content type
application/json
"string"