Caily API (v1)

Download OpenAPI specification:

[ANALYTICS] Events

Track event

Request Body schema: application/json

event_name required	string
payload required	object or null
device_id required	string

Responses

Request samples

Payload

Content type

application/json

{"event_name": "string",
"payload": { },
"device_id": "string"
}

Response samples

422

Content type

application/json

{"error": {"code": "validation_error",
"details": [{"key": "event_name",
"message": "Event name must be filled"
},
{"key": "payload",
"message": "Payload must be filled"
},
{"key": "device_id",
"message": "Device ID must be filled"
}
]
}
}

[B2B] Checkout Sessions

Create checkout session for new subscription

Authorizations:

Bearer Token

Request Body schema: application/json

subscription_plan_id required	integer
declared_number_of_seats required	integer
success_url required	string
cancel_url required	string

Responses

Request samples

Payload

Content type

application/json

{"subscription_plan_id": 1,
"declared_number_of_seats": 50,
"success_url": "https://test.admin.caily.com/b2b/subscription/success",
"cancel_url": "https://test.admin.caily.com/b2b/subscription/cancel"
}

Response samples

201
401
403
404
422

Content type

application/json

{"checkout_url": "https://checkout.stripe.com/c/checkout/test_session_id"
}

Create checkout session for draft subscription

Authorizations:

Bearer Token

Request Body schema: application/json

success_url required	string Success URL
cancel_url required	string Cancel URL

Responses

Request samples

Payload

Content type

application/json

{"success_url": "https://test.admin.caily.com/b2b/subscription/success",
"cancel_url": "https://test.admin.caily.com/b2b/subscription/cancel"
}

Response samples

201
401
403
404
422

Content type

application/json

{"checkout_url": "https://checkout.stripe.com/c/checkout/test_session_id"
}

[B2B] Consents

List consents

Responses

Response samples

200

Content type

application/json

[{"id": 2,
"consent_type": "terms_and_conditions",
"document_url": "http://minio:9000/caily-private/private_store/fb48394bfa912b2e40e757865ec5b452?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=minioadmin%2F20251205%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20251205T120630Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=dccc9c844c59966a554b1a4a2a11be02cadd25f26f487b9ba65dd0cc0572fd8c",
"version": 1
},
{"id": 1,
"consent_type": "privacy_policy",
"document_url": "http://minio:9000/caily-private/private_store/fb48394bfa912b2e40e757865ec5b452?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=minioadmin%2F20251205%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20251205T120630Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=dccc9c844c59966a554b1a4a2a11be02cadd25f26f487b9ba65dd0cc0572fd8c",
"version": 1
}
]

[B2B] Employees

Bulk delete employees

Authorizations:

Bearer Token

Request Body schema: application/json

employee_ids

required

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"employee_ids": [1,
2,
3
]
}

Response samples

401
403
422

Content type

application/json

{"error": {"code": "unauthorized",
"details": [{"key": "_base",
"message": "Session has expired"
}
]
}
}

Download employee import template

Authorizations:

Bearer Token

Responses

Response samples

401
403

Content type

application/json

{"error": {"code": "unauthorized",
"details": [{"key": "_base",
"message": "Session has expired"
}
]
}
}

Export organization employees to CSV

Authorizations:

Bearer Token

query Parameters

search_expression	string Search by name, surname and email
status	string Filter by employee status: `active` `pending`
departments[]	Array of strings Filter by departments

Responses

Response samples

401
403
422

Content type

application/json

{"error": {"code": "unauthorized",
"details": [{"key": "_base",
"message": "Session has expired"
}
]
}
}

Upload CSV file for employee import

Authorizations:

Bearer Token

Request Body schema: multipart/form-data

csv_file

required

string <binary>

Responses

Response samples

401
403
422

Content type

application/json

{"error": {"code": "unauthorized",
"details": [{"key": "_base",
"message": "Session has expired"
}
]
}
}

Validate CSV file for employee import

Authorizations:

Bearer Token

Request Body schema: multipart/form-data

csv_file

required

string <binary>

Responses

Response samples

200
401
403
422

Content type

application/json

{"employees_to_create": ["john.doe@example.com",
"jane.smith@example.com"
],
"employees_to_destroy": [ ],
"current_number_of_employees": 0,
"number_of_employees_after_update": 2
}

List organization employees

Authorizations:

Bearer Token

query Parameters

search_expression	string Search by name, surname and email
status	string Filter by employee status: `active` `pending`
departments[]	Array of strings Filter by departments
page	integer Page number for pagination
items_per_page	integer Number of items per page

Responses

Response samples

200
401
403
422

Content type

application/json

{"collection": [{"id": 30,
"first_name": "Alice",
"last_name": "Brown",
"email": "alice.brown@test.com",
"department": "Marketing",
"created_at": "2025-12-04T12:06:33.289423Z",
"updated_at": "2025-12-05T12:06:33.296153Z",
"status": "active"
},
{"id": 29,
"first_name": "Jane",
"last_name": "Smith",
"email": "jane.smith@test.com",
"department": "Finance Accounting",
"created_at": "2025-12-03T12:06:33.286778Z",
"updated_at": "2025-12-05T12:06:33.287781Z",
"status": "pending"
},
{"id": 28,
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@test.com",
"department": "Human Resources",
"created_at": "2025-12-02T12:06:33.279948Z",
"updated_at": "2025-12-05T12:06:33.282666Z",
"status": "pending"
}
],
"pagination": {"items_length": 3,
"page": 1,
"page_count": 1
}
}

Invite employee

Authorizations:

Bearer Token

Request Body schema: application/json

first_name required	string Employee first name
last_name required	string Employee last name
email required	string <email> Employee email address
department required	string Department name

Responses

Request samples

Payload

Content type

application/json

{"first_name": "Otto",
"last_name": "Johnson",
"email": "ottojohnson@organization.com",
"department": "Other"
}

Response samples

201
401
403
422

Content type

application/json

{"id": 43,
"first_name": "Otto",
"last_name": "Johnson",
"email": "ottojohnson@organization.com",
"department": "Other",
"created_at": "2025-12-05T12:06:33.526780Z",
"organization_id": 60
}

Resend employee invitations

Authorizations:

Bearer Token

Request Body schema: application/json

employee_ids

required

Array of integers

Array of employee IDs to resend invitations to

Responses

Request samples

Payload

Content type

application/json

{"employee_ids": [1,
2,
3
]
}

Response samples

401
403
422

Content type

application/json

{"error": {"code": "unauthorized",
"details": [{"key": "_base",
"message": "Session has expired"
}
]
}
}

[B2B] Organization Admin Users

Delete organization admin user

Authorizations:

Bearer Token

path Parameters

id

required

integer

Organization Admin User ID

Responses

Response samples

401
403
404
422

Content type

application/json

{"error": {"code": "unauthorized",
"details": [{"key": "_base",
"message": "Session has expired"
}
]
}
}

Update organization admin user

Authorizations:

Bearer Token

path Parameters

id

required

integer

Request Body schema: application/json

first_name	string
last_name	string
role	string Enum: "owner" "admin" "editor" "view_only"

Responses

Request samples

Payload

Content type

application/json

{"first_name": "string",
"last_name": "string",
"role": "owner"
}

Response samples

200
401
403
404
422

Content type

application/json

{"id": 121,
"first_name": "Updated First Name",
"last_name": "Updated Last Name",
"email": "organization_admin_user118@example.com",
"locale": "en",
"role": "view_only"
}

Export organization admin users to CSV

Authorizations:

Bearer Token

Responses

Response samples

401
403

Content type

application/json

{"error": {"code": "unauthorized",
"details": [{"key": "_base",
"message": "Session has expired"
}
]
}
}

Index organization admin users

Authorizations:

Bearer Token

Responses

Response samples

200
401
403

Content type

application/json

[{"id": 92,
"first_name": "John",
"last_name": "Doe",
"email": "organization_admin_user92@example.com",
"last_active_at": "2025-12-05T12:06:34.319083Z",
"role": "owner",
"is_invitation_accepted": true
},
{"id": 93,
"first_name": "Jane",
"last_name": "Smith",
"email": "organization_admin_user93@example.com",
"last_active_at": "2025-12-03T12:06:34.317256Z",
"role": "admin",
"is_invitation_accepted": true
},
{"id": 94,
"first_name": "Bob",
"last_name": "Johnson",
"email": "organization_admin_user94@example.com",
"last_active_at": null,
"role": "editor",
"is_invitation_accepted": false
},
{"id": 95,
"first_name": "Alice",
"last_name": "Brown",
"email": "organization_admin_user95@example.com",
"last_active_at": null,
"role": "view_only",
"is_invitation_accepted": false
}
]

Sign up

Request Body schema: application/json

invitation_token required	string
first_name required	string
last_name required	string
password required	string Password must be at least 12 characters long and contain at least one uppercase letter, one lowercase letter, one number, and one special character, no spaces

Responses

Request samples

Payload

Content type

application/json

{"invitation_token": "token",
"first_name": "John",
"last_name": "Doe",
"password": "Password100!"
}

Response samples

200
404
422

Content type

application/json

{"access_token": "b9xPaEBjnAv8kteuNuSS4dJ056L7IEp13DCnBQxQ5Ug",
"token_type": "Bearer",
"expires_in": 900,
"created_at": 1764936394,
"refresh_token": "K16SKl1miF_gu8uhQCU2mf-uFopiEfRZsAl1pU0GT0Q",
"organization_admin_user": {"id": 117,
"first_name": "John",
"last_name": "Doe",
"email": "organization_admin_user114@example.com",
"locale": "en",
"role": "owner"
}
}

Get invitation details

query Parameters

invitation_token

required

string

Invitation token to get details for

Responses

Response samples

200
404
422

Content type

application/json

{"email": "organization_admin_user104@example.com"
}

Invite organization admin user

Authorizations:

Bearer Token

Request Body schema: application/json

email required	string Email address of the user to invite
role required	string Enum: "owner" "admin" "editor" "view_only" Role of the user

Responses

Request samples

Payload

Content type

application/json

{"email": "john.doe@organization.com",
"role": "editor"
}

Response samples

201
401
403
422

Content type

application/json

{"id": 108,
"first_name": null,
"last_name": null,
"email": "john.doe@organization.com",
"locale": "en",
"role": "editor"
}

Reset password

Request Body schema: application/json

email

required

string

Responses

Request samples

Payload

Content type

application/json

{"email": "john.doe@organization.com"
}

Response samples

422

Content type

application/json

{"error": {"code": "validation_error",
"details": [{"key": "email",
"message": "Email address must be filled"
}
]
}
}

Set new password

Request Body schema: application/json

token required	string
password required	string
password_confirmation required	string

Responses

Request samples

Payload

Content type

application/json

{"password": "New-password123!@#",
"password_confirmation": "New-password123!@#",
"token": "password-reset-token"
}

Response samples

422

Content type

application/json

{"error": {"code": "validate_token_expiration",
"details": [{"key": "_base",
"message": "Token has expired"
}
]
}
}

[B2B] Organizations

Get organization departments

Authorizations:

Bearer Token

Responses

Response samples

200
401

Content type

application/json

["Human Resources",
"Finance & Accounting",
"Sales",
"Marketing",
"Information Technology",
"Operations",
"Customer Service",
"Legal",
"Procurement",
"Research & Development",
"Product Management",
"Engineering",
"Administration",
"Executive",
"Facilities Management",
"Quality Assurance",
"Supply Chain",
"Business Development",
"Compliance",
"Public Relations",
"Data Analytics",
"Security",
"Project Management",
"Health & Safety",
"Employee Wellness",
"Benefits Administration",
"Occupational Health",
"EHS",
"Medical Leave Management",
"Disability Management",
"Other"
]

Show organization

Authorizations:

Bearer Token

Responses

Response samples

200
401

Content type

application/json

{"id": 108,
"name": "Acme Corp",
"industry": "technology",
"primary_contact_email": "john.smith@acmecorp.com",
"primary_contact_name": null,
"created_at": "2025-12-05T12:06:35.152384Z",
"employees_count": 0,
"address": {"id": 1,
"street_name": "Tyler Haven",
"city": "East Lelandside",
"state_province": "Florida",
"zip_code": "11806",
"created_at": "2025-12-05T12:06:35.192299Z",
"updated_at": "2025-12-05T12:06:35.192299Z"
},
"has_ever_used_trial": false,
"has_ever_purchased_subscription": false,
"employees_changes_locked_until": null
}

Update organization

Authorizations:

Bearer Token

Request Body schema: application/json

name	string Organization name (optional)
industry	string Enum: "agriculture" "apparel" "banking" "biotechnology" "chemicals" "communications" "construction" "consulting" "education" "electronics" "energy" "engineering" "entertainment" "environmental" "finance" "food_and_beverage" "government" "healthcare" "hospitality" "insurance" "machinery" "manufacturing" "media" "not_for_profit" "other" "recreation" "retail" "shipping" "technology" "telecommunications" "transportation" "utilities" Organization industry (optional)
	object

Responses

Request samples

Payload

Content type

application/json

{"name": "Updated Acme Corp",
"industry": "technology",
"address": {"street_name": "123 Updated St",
"city": "San Francisco",
"state_province": "CA",
"zip_code": "94105"
}
}

Response samples

200
401
403
422

Content type

application/json

{"id": 114,
"name": "Updated Acme Corp",
"industry": "healthcare",
"primary_contact_email": "melissa@marvin.test",
"primary_contact_name": null,
"created_at": "2025-12-05T12:06:35.528527Z",
"employees_count": 0,
"address": {"id": 7,
"street_name": "123 Market Street",
"city": "San Francisco",
"state_province": "California",
"zip_code": "94103",
"created_at": "2025-12-05T12:06:35.558133Z",
"updated_at": "2025-12-05T12:06:35.558133Z"
},
"has_ever_used_trial": false,
"has_ever_purchased_subscription": false,
"employees_changes_locked_until": null
}

Get organization statistics

Authorizations:

Bearer Token

Responses

Response samples

200
401
403

Content type

application/json

{"seats": 0,
"active_users": 0,
"last_login_activity": 0,
"max_seats": 100
}

[B2B] Profiles

Change current organization admin user's password

Authorizations:

Bearer Token

Request Body schema: application/json

current_password required	string
password required	string Password must be at least 12 characters long and contain at least one uppercase letter, one lowercase letter, one number, and one special character
password_confirmation required	string Password must be at least 12 characters long and contain at least one uppercase letter, one lowercase letter, one number, and one special character

Responses

Request samples

Payload

Content type

application/json

{"current_password": "Password123!",
"password": "New-password123!@#",
"password_confirmation": "New-password123!@#"
}

Response samples

401
422

Content type

application/json

{"error": {"code": "unauthorized",
"details": [{"key": "_base",
"message": "Session has expired"
}
]
}
}

Show current organization admin user's profile

Authorizations:

Bearer Token

Responses

Response samples

200
401

Content type

application/json

Example

when everything is ok

{"id": 146,
"first_name": "Timothy",
"last_name": "Miller",
"email": "organization_admin_user143@example.com",
"locale": "en",
"role": "owner"
}

Update current organization admin user's profile

Authorizations:

Bearer Token

Request Body schema: application/json

first_name	string
last_name	string
email	string

Responses

Request samples

Payload

Content type

application/json

{"first_name": "string",
"last_name": "string",
"email": "string"
}

Response samples

200
401
422

Content type

application/json

{"id": 149,
"first_name": "Jane",
"last_name": "Smith",
"email": "new_email@example.com",
"locale": "en",
"role": "owner"
}

[B2B] Self Enrollments

Create organization admin user

Request Body schema: application/json

admin_account_creation_token required	string Admin account creation token from organization
first_name required	string First name of the organization admin user
last_name required	string Last name of the organization admin user
password required	string Password must be at least 12 characters long and contain at least one uppercase letter, one lowercase letter, one number, and one special character

Responses

Request samples

Payload

Content type

application/json

{"admin_account_creation_token": "token",
"first_name": "John",
"last_name": "Doe",
"password": "Password100!"
}

Response samples

404
422

Content type

application/json

{"error": {"code": "fetch_organization",
"details": [{"key": "admin_account_creation_token",
"message": "Account creation time has expired. Please contact support."
}
]
}
}

Create self enrollment

Request Body schema: application/json

subscription_plan_id required	integer Subscription plan ID (must be null for trial)
name required	string Organization name
declared_number_of_seats	integer Number of seats (required when subscription_plan_id is provided)
industry required	string Enum: "agriculture" "apparel" "banking" "biotechnology" "chemicals" "communications" "construction" "consulting" "education" "electronics" "energy" "engineering" "entertainment" "environmental" "finance" "food_and_beverage" "government" "healthcare" "hospitality" "insurance" "machinery" "manufacturing" "media" "not_for_profit" "other" "recreation" "retail" "shipping" "technology" "telecommunications" "transportation" "utilities" Organization industry
primary_contact_email required	string Primary contact person email
required	object

Responses

Request samples

Payload

Content type

application/json

Example

Creates a new organization with subscription plan

{"subscription_plan_id": 1,
"name": "Acme Corp",
"declared_number_of_seats": 10,
"industry": "technology",
"primary_contact_email": "john.smith@acmecorp.com",
"address": {"street_name": "123 Market Street",
"city": "San Francisco",
"state_province": "California",
"zip_code": "94103"
}
}

Response samples

201
404
422

Content type

application/json

{"checkout_url": "https://checkout.stripe.com/c/checkout/test_session_id",
"trial_activated": false,
"admin_account_creation_token": null
}

[B2B] Sessions

Sign in / Refresh token

Request Body schema: application/json

refresh_token	string only in case of grant_type=refresh_token
email	string only in case of grant_type=password
password	string only in case of grant_type=password
grant_type required	string Enum: "password" "refresh_token"
scope required	string Value: "b2b"

Responses

Request samples

Payload

Content type

application/json

Example

Sign in via email

{"email": "admin@organization.com",
"password": "Password9000!",
"grant_type": "password",
"scope": "b2b"
}

Response samples

200
400

Content type

application/json

Example

b2b

{"access_token": "KHv_iVluK17W3L3hf9wq9XA5E9HXin5sMcQWvSTzcA0",
"token_type": "Bearer",
"expires_in": 900,
"refresh_token": "YFbI5GO-FoF5IcCrQtGKutAdDUNl8DKqn8KCIkuCrOM",
"scope": "b2b",
"created_at": 1728561600,
"user": {"id": 155,
"first_name": "Stuart",
"last_name": "Welch",
"email": "organization_admin_user150@example.com",
"locale": "en",
"role": "owner"
}
}

Logout

Request Body schema: application/json

token

required

string

Responses

Request samples

Payload

Content type

application/json

{"token": "RMFTakb-8kWVknGmqAHsmvWrY_aUXpBc4N2-GdHOC6I"
}

Response samples

200

Content type

application/json

{ }

[B2B] Subscription Plans

Get subscription plans based on employees count

Authorizations:

Bearer Token

Responses

Response samples

200
401
403
404

Content type

application/json

[{"id": 124,
"name": "Small Business",
"min_seats": 0,
"max_seats": 100,
"price_per_seat": 9,
"currency": "USD",
"billing_cycle": "monthly",
"display_order": 1
},
{"id": 125,
"name": "Small Business",
"min_seats": 0,
"max_seats": 100,
"price_per_seat": 108,
"currency": "USD",
"billing_cycle": "yearly",
"display_order": 1
}
]

Get subscription plans

Responses

Response samples

200

Content type

application/json

[{"id": 184,
"name": "Small Business",
"min_seats": 0,
"max_seats": 100,
"price_per_seat": 9,
"currency": "USD",
"billing_cycle": "monthly",
"display_order": 1
},
{"id": 185,
"name": "Medium Business",
"min_seats": 101,
"max_seats": 250,
"price_per_seat": 6.5,
"currency": "USD",
"billing_cycle": "monthly",
"display_order": 2
},
{"id": 186,
"name": "Large Business",
"min_seats": 251,
"max_seats": 500,
"price_per_seat": 5,
"currency": "USD",
"billing_cycle": "monthly",
"display_order": 3
},
{"id": 187,
"name": "Small Business",
"min_seats": 0,
"max_seats": 100,
"price_per_seat": 108,
"currency": "USD",
"billing_cycle": "yearly",
"display_order": 1
},
{"id": 188,
"name": "Medium Business",
"min_seats": 101,
"max_seats": 250,
"price_per_seat": 78,
"currency": "USD",
"billing_cycle": "yearly",
"display_order": 2
},
{"id": 189,
"name": "Large Business",
"min_seats": 251,
"max_seats": 500,
"price_per_seat": 60,
"currency": "USD",
"billing_cycle": "yearly",
"display_order": 3
}
]

[B2B] Stripe

Create billing portal session

Authorizations:

Bearer Token

Responses

Response samples

201
401
403
422

Content type

application/json

{"id": "billing_portal_session_id",
"url": "https://billing.stripe.com/p/login/test_billing_portal_session_id"
}

[B2B] Subscriptions

Show current organization subscription

Authorizations:

Bearer Token

Responses

Response samples

200
401
403
404

Content type

application/json

{"id": 93,
"price_per_seat": 900,
"number_of_seats": null,
"currency": null,
"currency_symbol": null,
"status": "active",
"current_billing_period_ends_at": "2026-01-05T12:06:37.184518Z",
"cancel_at": null,
"created_at": "2025-12-05T12:06:37.184745Z",
"is_trial": false,
"subscription_plan": {"id": 190,
"name": "Small Business",
"min_seats": 0,
"max_seats": 100,
"price_per_seat": 9,
"currency": "USD",
"billing_cycle": "monthly"
},
"percent_off": null
}

Show draft organization subscription

Authorizations:

Bearer Token

Responses

Response samples

200
401
403
404

Content type

application/json

{"id": 96,
"price_per_seat": 900,
"number_of_seats": null,
"currency": null,
"currency_symbol": null,
"status": "draft",
"current_billing_period_ends_at": "2026-01-05T12:06:37.278795Z",
"cancel_at": null,
"created_at": "2025-12-05T12:06:37.278944Z",
"is_trial": false,
"subscription_plan": {"id": 194,
"name": "Small Business",
"min_seats": 0,
"max_seats": 100,
"price_per_seat": 9,
"currency": "USD",
"billing_cycle": "monthly"
},
"percent_off": null
}

[B2B] Toolkit Files

Index toolkit files

Authorizations:

Bearer Token

query Parameters

search_expression	string Search by file name
toolkit_folder_id	integer Filter by toolkit folder ID
sort_by	string Sort by column: `created_at` `name`
direction	string Sort direction
page	integer Page number for pagination
items_per_page	integer Number of items per page

Responses

Response samples

200
401
403
422

Content type

application/json

{"collection": [{"id": 1,
"name": "document1.pdf",
"size": 177392,
"file_url": "http://minio:9000/caily-private/private_store/fb48394bfa912b2e40e757865ec5b452.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=minioadmin%2F20251205%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20251205T120637Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=fedb1d64a0b2a9977e6d3e34be29ebd6bb77ddf783aca3602726eeba6864380b"
},
{"id": 2,
"name": "image1.png",
"size": 177392,
"file_url": "http://minio:9000/caily-private/private_store/fb48394bfa912b2e40e757865ec5b452.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=minioadmin%2F20251205%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20251205T120637Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=fedb1d64a0b2a9977e6d3e34be29ebd6bb77ddf783aca3602726eeba6864380b"
},
{"id": 4,
"name": "presentation.pptx",
"size": 177392,
"file_url": "http://minio:9000/caily-private/private_store/fb48394bfa912b2e40e757865ec5b452.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=minioadmin%2F20251205%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20251205T120637Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=fedb1d64a0b2a9977e6d3e34be29ebd6bb77ddf783aca3602726eeba6864380b"
},
{"id": 3,
"name": "spreadsheet.xlsx",
"size": 177392,
"file_url": "http://minio:9000/caily-private/private_store/fb48394bfa912b2e40e757865ec5b452.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=minioadmin%2F20251205%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20251205T120637Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=fedb1d64a0b2a9977e6d3e34be29ebd6bb77ddf783aca3602726eeba6864380b"
}
],
"pagination": {"items_length": 4,
"page": 1,
"page_count": 1
}
}

[B2B] Toolkit Folders

Index toolkit folders

Authorizations:

Bearer Token

query Parameters

page	integer Page number for pagination
items_per_page	integer Number of items per page

Responses

Response samples

200
401
403

Content type

application/json

{"collection": [{"id": 9,
"name": "Folder 1",
"toolkit_files_count": 0
},
{"id": 10,
"name": "Folder 2",
"toolkit_files_count": 0
},
{"id": 11,
"name": "Folder 3",
"toolkit_files_count": 0
}
],
"pagination": {"items_length": 3,
"page": 1,
"page_count": 1
}
}

[CAILY_ADMIN] Caily Admin Users

Delete caily admin user

Authorizations:

Bearer Token

path Parameters

id

required

integer

Caily Admin User ID

Responses

Response samples

401
403
404
422

Content type

application/json

{"error": {"code": "unauthorized",
"details": [{"key": "_base",
"message": "Session has expired"
}
]
}
}

Update caily admin user

Authorizations:

Bearer Token

path Parameters

id

required

integer

Request Body schema: application/json

first_name	string
last_name	string
role	string Enum: "super_admin" "account_executive" "support_agent" "view_only"

Responses

Request samples

Payload

Content type

application/json

{"first_name": "string",
"last_name": "string",
"role": "super_admin"
}

Response samples

200
401
403
404
422

Content type

application/json

{"id": 52,
"first_name": "Updated First Name",
"last_name": "Updated Last Name",
"email": "caily_admin_user49@example.com",
"locale": "en",
"role": "view_only"
}

Export caily admin users to CSV

Authorizations:

Bearer Token

Responses

Response samples

401
403

Content type

application/json

{"error": {"code": "unauthorized",
"details": [{"key": "_base",
"message": "Session has expired"
}
]
}
}

Index caily admin users

Authorizations:

Bearer Token

Responses

Response samples

200
401
403

Content type

application/json

[{"id": 24,
"first_name": "John",
"last_name": "Doe",
"email": "caily_admin_user24@example.com",
"last_active_at": "2025-12-05T12:06:38.007317Z",
"role": "super_admin",
"is_invitation_accepted": true
},
{"id": 25,
"first_name": "Jane",
"last_name": "Smith",
"email": "caily_admin_user25@example.com",
"last_active_at": "2025-12-03T12:06:38.004987Z",
"role": "account_executive",
"is_invitation_accepted": true
},
{"id": 26,
"first_name": "Bob",
"last_name": "Johnson",
"email": "caily_admin_user26@example.com",
"last_active_at": null,
"role": "support_agent",
"is_invitation_accepted": false
},
{"id": 27,
"first_name": "Alice",
"last_name": "Brown",
"email": "caily_admin_user27@example.com",
"last_active_at": null,
"role": "view_only",
"is_invitation_accepted": false
}
]

Sign up

Request Body schema: application/json

invitation_token required	string
first_name required	string
last_name required	string
password required	string Password must be at least 12 characters long and contain at least one uppercase letter, one lowercase letter, one number, and one special character, no spaces

Responses

Request samples

Payload

Content type

application/json

{"invitation_token": "token",
"first_name": "John",
"last_name": "Doe",
"password": "Password100!"
}

Response samples

200
404
422

Content type

application/json

{"access_token": "i_B68jKjlmpKEZuk7jc7lNM4oGXoEpGS7peCves1DRg",
"token_type": "Bearer",
"expires_in": 900,
"created_at": 1764936398,
"refresh_token": "JUDKh5WKR5ICfe6IddkVhEMgUcU2lLvn-6XNMup8iD8",
"caily_admin_user": {"id": 48,
"first_name": "John",
"last_name": "Doe",
"email": "caily_admin_user45@example.com",
"locale": "en",
"role": "super_admin"
}
}

Get invitation details

query Parameters

invitation_token

required

string

Invitation token to get details for

Responses

Response samples

200
404

Content type

application/json

{"email": "caily_admin_user36@example.com"
}

Invite caily admin user

Authorizations:

Bearer Token

Request Body schema: application/json

email required	string Email address of the user to invite
role required	string Enum: "super_admin" "account_executive" "support_agent" "view_only" Role of the user

Responses

Request samples

Payload

Content type

application/json

{"email": "john.doe@caily.com",
"role": "account_executive"
}

Response samples

201
401
403
422

Content type

application/json

{"id": 39,
"first_name": null,
"last_name": null,
"email": "john.doe@caily.com",
"locale": "en",
"role": "account_executive"
}

Reset password

Request Body schema: application/json

email

required

string

Responses

Request samples

Payload

Content type

application/json

{"email": "john.doe@example.com"
}

Response samples

422

Content type

application/json

{"error": {"code": "validation_error",
"details": [{"key": "email",
"message": "Email address must be filled"
}
]
}
}

Set new password

Request Body schema: application/json

token required	string
password required	string
password_confirmation required	string

Responses

Request samples

Payload

Content type

application/json

{"password": "New-password123!@#",
"password_confirmation": "New-password123!@#",
"token": "password-reset-token"
}

Response samples

422

Content type

application/json

{"error": {"code": "validate_token_expiration",
"details": [{"key": "_base",
"message": "Token has expired"
}
]
}
}

[CAILY_ADMIN] Employees

Export organization employees to CSV

Authorizations:

Bearer Token

path Parameters

organization_id

required

integer

Organization ID

query Parameters

search_expression	string Search by name, surname and email
status	string Filter by employee status: `active` `pending`
departments[]	Array of strings Filter by departments

Responses

Response samples

401
403
404
422

Content type

application/json

{"error": {"code": "unauthorized",
"details": [{"key": "_base",
"message": "Session has expired"
}
]
}
}

List organization employees

Authorizations:

Bearer Token

path Parameters

organization_id

required

integer

Organization ID

query Parameters

search_expression	string Search by name, surname and email
status	string Filter by employee status: `active` `pending`
departments[]	Array of strings Filter by departments
page	integer Page number for pagination
items_per_page	integer Number of items per page

Responses

Response samples

200
401
403
404
422

Content type

application/json

{"collection": [{"id": 73,
"first_name": "Alice",
"last_name": "Brown",
"email": "alice.brown@test.com",
"department": "Marketing",
"created_at": "2025-12-04T12:06:38.751759Z",
"updated_at": "2025-12-05T12:06:38.756657Z",
"status": "active"
},
{"id": 72,
"first_name": "Jane",
"last_name": "Smith",
"email": "jane.smith@test.com",
"department": "Finance Accounting",
"created_at": "2025-12-03T12:06:38.748584Z",
"updated_at": "2025-12-05T12:06:38.749775Z",
"status": "pending"
},
{"id": 71,
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@test.com",
"department": "Human Resources",
"created_at": "2025-12-02T12:06:38.745531Z",
"updated_at": "2025-12-05T12:06:38.746353Z",
"status": "pending"
}
],
"pagination": {"items_length": 3,
"page": 1,
"page_count": 1
}
}

[CAILY_ADMIN] Organization Admin Users

List organization admin users

Authorizations:

Bearer Token

path Parameters

organization_id

required

integer

Organization ID

query Parameters

search_expression	string Search by name, surname and email
status	string Filter by organization admin user status: `active` `pending`
roles	Array of strings Items Enum: "owner" "admin" "editor" "view_only" Filter by roles
page	integer Page number for pagination
items_per_page	integer Number of items per page

Responses

Response samples

200
401
403
404
422

Content type

application/json

{"collection": [{"id": 186,
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@test.com",
"last_active_at": "2025-12-04T12:06:38.956413Z",
"role": "owner",
"is_invitation_accepted": true
},
{"id": 187,
"first_name": "Jane",
"last_name": "Smith",
"email": "jane.smith@test.com",
"last_active_at": "2025-12-03T12:06:38.957871Z",
"role": "admin",
"is_invitation_accepted": true
}
],
"pagination": {"items_length": 2,
"page": 1,
"page_count": 1
}
}

Resend primary contact invitation

Authorizations:

Bearer Token

path Parameters

id

required

integer

Organization Admin User ID

Responses

Response samples

401
403
404
422

Content type

application/json

{"error": {"code": "unauthorized",
"details": [{"key": "_base",
"message": "Session has expired"
}
]
}
}

[CAILY_ADMIN] Organizations

Create organization

Authorizations:

Bearer Token

Request Body schema: application/json

subscription_plan_id required	integer ID of the subscription plan
name required	string Organization name
declared_number_of_seats required	integer Number of seats declared by the organization
industry required	string Enum: "agriculture" "apparel" "banking" "biotechnology" "chemicals" "communications" "construction" "consulting" "education" "electronics" "energy" "engineering" "entertainment" "environmental" "finance" "food_and_beverage" "government" "healthcare" "hospitality" "insurance" "machinery" "manufacturing" "media" "not_for_profit" "other" "recreation" "retail" "shipping" "technology" "telecommunications" "transportation" "utilities" Organization industry
primary_contact_email required	string Primary contact person email
required	object
stripe_coupon_id	string Stripe coupon ID

Responses

Request samples

Payload

Content type

application/json

{"subscription_plan_id": 1,
"name": "Acme Corp",
"declared_number_of_seats": 550,
"industry": "technology",
"primary_contact_email": "john.smith@acmecorp.com",
"address": {"street_name": "123 Market Street",
"city": "San Francisco",
"state_province": "California",
"zip_code": "94103"
},
"stripe_coupon_id": "coupon_123"
}

Response samples

201
401
403
404
422

Content type

application/json

{"id": 187,
"name": "Acme Corp",
"declared_number_of_seats": 550,
"industry": "technology",
"primary_contact_email": "john.smith@acmecorp.com",
"primary_contact_name": null,
"created_at": "2025-12-05T12:06:39.352923Z",
"updated_at": "2025-12-05T12:06:39.352923Z",
"employees_count": 0,
"status": "draft",
"address": {"id": 12,
"street_name": "123 Market Street",
"city": "San Francisco",
"state_province": "California",
"zip_code": "94103",
"created_at": "2025-12-05T12:06:39.356155Z",
"updated_at": "2025-12-05T12:06:39.356155Z"
},
"current_subscription": null,
"draft_subscription": {"id": 104,
"number_of_seats": 550,
"subscription_plan": {"id": 203,
"name": "Upper Mid Market",
"min_seats": 501,
"max_seats": 1000,
"price_per_seat": 3.5,
"currency": "USD",
"billing_cycle": "monthly"
},
"stripe_coupon_id": "coupon_123",
"percent_off": 20
},
"max_subscription_plan_tier_order": 3
}

Index organizations

Authorizations:

Bearer Token

query Parameters

search_expression	string
page	integer
items_per_page	integer
industries	Array of strings Items Enum: "agriculture" "apparel" "banking" "biotechnology" "chemicals" "communications" "construction" "consulting" "education" "electronics" "energy" "engineering" "entertainment" "environmental" "finance" "food_and_beverage" "government" "healthcare" "hospitality" "insurance" "machinery" "manufacturing" "media" "not_for_profit" "other" "recreation" "retail" "shipping" "technology" "telecommunications" "transportation" "utilities"
status	Array of strings Items Enum: "draft" "active"
b2b_subscription_tier_ids	Array of integers
is_trial	boolean

Responses

Response samples

200
401
403
422

Content type

application/json

{"collection": [{"id": 214,
"name": "Tech Solutions",
"industry": "technology",
"primary_contact_email": "simone_mccullough@howell-conn.example",
"primary_contact_name": null,
"created_at": "2025-12-05T12:06:39.867581Z",
"employees_count": 0,
"status": "draft",
"subscription": null
},
{"id": 213,
"name": "Healthcare Plus",
"industry": "healthcare",
"primary_contact_email": "elidia_hartmann@gusikowski.test",
"primary_contact_name": null,
"created_at": "2025-12-04T12:06:39.862495Z",
"employees_count": 0,
"status": "draft",
"subscription": null
},
{"id": 212,
"name": "Acme Corporation",
"industry": "technology",
"primary_contact_email": "tad@borer.example",
"primary_contact_name": null,
"created_at": "2025-12-03T12:06:39.857210Z",
"employees_count": 0,
"status": "draft",
"subscription": null
}
],
"pagination": {"items_length": 3,
"page": 1,
"page_count": 1
}
}

Get organization departments

Authorizations:

Bearer Token

path Parameters

id

required

string

Organization ID

Responses

Response samples

200
401
403
404
422

Content type

application/json

["Human Resources",
"Finance & Accounting",
"Sales",
"Marketing",
"Information Technology",
"Operations",
"Customer Service",
"Legal",
"Procurement",
"Research & Development",
"Product Management",
"Engineering",
"Administration",
"Executive",
"Facilities Management",
"Quality Assurance",
"Supply Chain",
"Business Development",
"Compliance",
"Public Relations",
"Data Analytics",
"Security",
"Project Management",
"Health & Safety",
"Employee Wellness",
"Benefits Administration",
"Occupational Health",
"EHS",
"Medical Leave Management",
"Disability Management",
"Other"
]

Export organizations to CSV

Authorizations:

Bearer Token

query Parameters

search_expression	string
page	integer
items_per_page	integer
industries	Array of strings Items Enum: "agriculture" "apparel" "banking" "biotechnology" "chemicals" "communications" "construction" "consulting" "education" "electronics" "energy" "engineering" "entertainment" "environmental" "finance" "food_and_beverage" "government" "healthcare" "hospitality" "insurance" "machinery" "manufacturing" "media" "not_for_profit" "other" "recreation" "retail" "shipping" "technology" "telecommunications" "transportation" "utilities"
status	Array of strings Items Enum: "draft" "active"
b2b_subscription_tier_ids	Array of integers
is_trial	boolean

Responses

Response samples

401
403
422

Content type

application/json

{"error": {"code": "unauthorized",
"details": [{"key": "_base",
"message": "Session has expired"
}
]
}
}

Set max subscription plan tier for organization

Authorizations:

Bearer Token

path Parameters

id

required

string

Organization ID

Request Body schema: application/json

subscription_plan_tier_id

required

integer

ID of the subscription plan tier to set as maximum

Responses

Request samples

Payload

Content type

application/json

{"subscription_plan_tier_id": 2
}

Response samples

200
401
403
404
422

Content type

application/json

{"id": 230,
"name": "Nader, Heidenreich and Rolfson 131",
"declared_number_of_seats": 10,
"industry": "technology",
"primary_contact_email": "moshe.becker@will-murphy.example",
"primary_contact_name": null,
"created_at": "2025-12-05T12:06:40.044735Z",
"updated_at": "2025-12-05T12:06:40.062081Z",
"employees_count": 0,
"status": "draft",
"address": {"id": 49,
"street_name": "Funk Fields",
"city": "Lake Michelfort",
"state_province": "Oklahoma",
"zip_code": "39799-2458",
"created_at": "2025-12-05T12:06:40.046626Z",
"updated_at": "2025-12-05T12:06:40.046626Z"
},
"current_subscription": null,
"draft_subscription": null,
"max_subscription_plan_tier_order": 4
}

Show organization

Authorizations:

Bearer Token

path Parameters

id

required

string

Organization ID

Responses

Response samples

200
401
403
404
422

Content type

application/json

{"id": 239,
"name": "Larkin, Fahey and Weissnat 140",
"declared_number_of_seats": 10,
"industry": "technology",
"primary_contact_email": "davis@herman-bayer.example",
"primary_contact_name": null,
"created_at": "2025-12-05T12:06:40.293643Z",
"updated_at": "2025-12-05T12:06:40.293643Z",
"employees_count": 0,
"status": "draft",
"address": {"id": 57,
"street_name": "Bradtke Ville",
"city": "Isabellaburgh",
"state_province": "North Carolina",
"zip_code": "54009",
"created_at": "2025-12-05T12:06:40.295853Z",
"updated_at": "2025-12-05T12:06:40.295853Z"
},
"current_subscription": null,
"draft_subscription": {"id": 106,
"number_of_seats": 50,
"subscription_plan": {"id": 212,
"name": "Small Business",
"min_seats": 0,
"max_seats": 100,
"price_per_seat": 9,
"currency": "USD",
"billing_cycle": "monthly"
},
"stripe_coupon_id": null,
"percent_off": null
},
"max_subscription_plan_tier_order": 3
}

Update organization

Authorizations:

Bearer Token

path Parameters

id

required

string

Organization ID

Request Body schema: application/json

name	string Organization name (optional)
declared_number_of_seats	integer Number of seats declared by the organization (optional)
industry	string Enum: "agriculture" "apparel" "banking" "biotechnology" "chemicals" "communications" "construction" "consulting" "education" "electronics" "energy" "engineering" "entertainment" "environmental" "finance" "food_and_beverage" "government" "healthcare" "hospitality" "insurance" "machinery" "manufacturing" "media" "not_for_profit" "other" "recreation" "retail" "shipping" "technology" "telecommunications" "transportation" "utilities" Organization industry (optional)
primary_contact_email	string Primary contact person email (optional)
	object

Responses

Request samples

Payload

Content type

application/json

{"name": "Updated Acme Corp",
"declared_number_of_seats": 10,
"industry": "finance",
"primary_contact_email": "updated.john@updatedacme.com",
"address": {"street_name": "456 Updated Street",
"city": "Updated City",
"state_province": "Updated State",
"zip_code": "54321"
}
}

Response samples

200
401
403
404
422

Content type

application/json

{"id": 244,
"name": "Updated Acme Corp",
"declared_number_of_seats": 10,
"industry": "technology",
"primary_contact_email": "john.smith@acmecorp.com",
"primary_contact_name": null,
"created_at": "2025-12-05T12:06:40.465094Z",
"updated_at": "2025-12-05T12:06:40.475652Z",
"employees_count": 0,
"status": "draft",
"address": {"id": 62,
"street_name": "123 Market Street",
"city": "San Francisco",
"state_province": "California",
"zip_code": "94103",
"created_at": "2025-12-05T12:06:40.467117Z",
"updated_at": "2025-12-05T12:06:40.467117Z"
},
"current_subscription": null,
"draft_subscription": null,
"max_subscription_plan_tier_order": 3
}

[CAILY_ADMIN] Profiles

Change current caily admin user's password

Authorizations:

Bearer Token

Request Body schema: application/json

current_password required	string
password required	string Password must be at least 12 characters long and contain at least one uppercase letter, one lowercase letter, one number, and one special character, no spaces
password_confirmation required	string Password must be at least 12 characters long and contain at least one uppercase letter, one lowercase letter, one number, and one special character, no spaces

Responses

Request samples

Payload

Content type

application/json

{"current_password": "Password123!",
"password": "New-password123!@#",
"password_confirmation": "New-password123!@#"
}

Response samples

401
422

Content type

application/json

{"error": {"code": "unauthorized",
"details": [{"key": "_base",
"message": "Session has expired"
}
]
}
}

Show current caily admin user's profile

Authorizations:

Bearer Token

Responses

Response samples

200
401

Content type

application/json

Example

when everything is ok

{"id": 137,
"first_name": "Quiana Parker",
"last_name": "Jonathan Kunze",
"email": "caily_admin_user134@example.com",
"locale": "en",
"role": "super_admin"
}

Update current caily admin user's profile

Authorizations:

Bearer Token

Request Body schema: application/json

first_name	string
last_name	string

Responses

Request samples

Payload

Content type

application/json

{"first_name": "string",
"last_name": "string"
}

Response samples

200
401
422

Content type

application/json

{"id": 140,
"first_name": "Jane",
"last_name": "Smith",
"email": "caily_admin_user137@example.com",
"locale": "en",
"role": "super_admin"
}

[CAILY_ADMIN] Sessions

Sign in / Refresh token

Request Body schema: application/json

refresh_token	string only in case of grant_type=refresh_token
email	string only in case of grant_type=password
password	string only in case of grant_type=password
grant_type required	string Enum: "password" "refresh_token"
scope required	string Value: "caily_admin"

Responses

Request samples

Payload

Content type

application/json

Example

Sign in via email

{"email": "admin@caily.com",
"password": "Password9000!",
"grant_type": "password",
"scope": "caily_admin"
}

Response samples

200
400

Content type

application/json

Example

caily_admin

{"access_token": "rqrzc10v8sz_ldSZZSvC08GwWLW2ICy3MMD5wHgIYwc",
"token_type": "Bearer",
"expires_in": 900,
"refresh_token": "Q1KiLMei7UMsiW6R8hhPGXxkpaEofnxNyUQ2JucufQY",
"scope": "caily_admin",
"created_at": 1728561600,
"user": {"id": 144,
"first_name": "Vicki Green DC",
"last_name": "Rafael Brakus",
"email": "caily_admin_user141@example.com",
"locale": "en",
"role": "super_admin"
}
}

Logout

Request Body schema: application/json

token

required

string

Responses

Request samples

Payload

Content type

application/json

{"token": "RMFTakb-8kWVknGmqAHsmvWrY_aUXpBc4N2-GdHOC6I"
}

Response samples

200

Content type

application/json

{ }

[CAILY_ADMIN] Stripe Coupons

Show stripe coupon

Authorizations:

Bearer Token

path Parameters

stripe_coupon_id

required

string

Stripe coupon ID

Responses

Response samples

200
403
404
422

Content type

application/json

{"id": "coupon_123",
"name": "20% discount forever",
"percent_off": 20,
"duration_type": "forever",
"duration_in_months": null
}

[CAILY_ADMIN] Subscription Plan Tiers

Get subscription plan tiers

Authorizations:

Bearer Token

Responses

Response samples

200
401
403

Content type

application/json

[{"id": 209,
"name": "Small Business",
"min_seats": 0,
"max_seats": 100,
"upgrade_order": 1,
"display_order": 1,
"available_for_self_enrollment": true
},
{"id": 210,
"name": "Medium Business",
"min_seats": 101,
"max_seats": 250,
"upgrade_order": 2,
"display_order": 2,
"available_for_self_enrollment": true
},
{"id": 211,
"name": "Large Business",
"min_seats": 251,
"max_seats": 500,
"upgrade_order": 3,
"display_order": 3,
"available_for_self_enrollment": true
},
{"id": 212,
"name": "Upper Mid Market",
"min_seats": 501,
"max_seats": 1000,
"upgrade_order": 4,
"display_order": 4,
"available_for_self_enrollment": false
},
{"id": 213,
"name": "Large Enterprise",
"min_seats": 1001,
"max_seats": 5000,
"upgrade_order": 5,
"display_order": 5,
"available_for_self_enrollment": false
},
{"id": 214,
"name": "Enterprise Systems",
"min_seats": 5001,
"max_seats": null,
"upgrade_order": 6,
"display_order": 6,
"available_for_self_enrollment": false
}
]

[CAILY_ADMIN] Subscription Plans

Get subscription plans

Authorizations:

Bearer Token

Responses

Response samples

200
401
403

Content type

application/json

[{"id": 217,
"name": "Small Business",
"min_seats": 0,
"max_seats": 100,
"price_per_seat": 9,
"currency": "USD",
"billing_cycle": "monthly",
"display_order": 1,
"available_for_self_enrollment": true
},
{"id": 218,
"name": "Medium Business",
"min_seats": 101,
"max_seats": 250,
"price_per_seat": 6.5,
"currency": "USD",
"billing_cycle": "monthly",
"display_order": 2,
"available_for_self_enrollment": true
},
{"id": 219,
"name": "Large Business",
"min_seats": 251,
"max_seats": 500,
"price_per_seat": 5,
"currency": "USD",
"billing_cycle": "monthly",
"display_order": 3,
"available_for_self_enrollment": true
},
{"id": 223,
"name": "Upper Mid Market",
"min_seats": 501,
"max_seats": 1000,
"price_per_seat": 3.5,
"currency": "USD",
"billing_cycle": "monthly",
"display_order": 4,
"available_for_self_enrollment": false
},
{"id": 220,
"name": "Small Business",
"min_seats": 0,
"max_seats": 100,
"price_per_seat": 108,
"currency": "USD",
"billing_cycle": "yearly",
"display_order": 1,
"available_for_self_enrollment": true
},
{"id": 221,
"name": "Medium Business",
"min_seats": 101,
"max_seats": 250,
"price_per_seat": 78,
"currency": "USD",
"billing_cycle": "yearly",
"display_order": 2,
"available_for_self_enrollment": true
},
{"id": 222,
"name": "Large Business",
"min_seats": 251,
"max_seats": 500,
"price_per_seat": 60,
"currency": "USD",
"billing_cycle": "yearly",
"display_order": 3,
"available_for_self_enrollment": true
},
{"id": 224,
"name": "Enterprise Systems",
"min_seats": 5001,
"max_seats": null,
"price_per_seat": 24,
"currency": "USD",
"billing_cycle": "yearly",
"display_order": 6,
"available_for_self_enrollment": false
}
]

Get Stripe B2B Product link

Authorizations:

Bearer Token

Responses

Response samples

200
401
403

Content type

application/json

{"url": "https://dashboard.stripe.com/acct_test/test/products/prod_test"
}

[CAILY_ADMIN] Toolkit Files

Create toolkit file

Authorizations:

Bearer Token

Request Body schema: multipart/form-data

toolkit_folder_id required	integer
file required	string <binary>

Responses

Request samples

Payload

Content type

multipart/form-data

{
  "toolkit_folder_id": 1,
  "file": "#<ActionDispatch::Http::UploadedFile:0x00007fa8dd2b56a0>"
}

Response samples

201
401
403
404
422

Content type

application/json

{"id": 17,
"name": "example-pdf20251205-82-dd82xk.pdf",
"size": 0,
"file_url": "http://minio:9000/caily-private/private_store/toolkit_file/17/example-pdf20251205-82-dd82xk-17.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=minioadmin%2F20251205%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20251205T120641Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=759d3f79cae143a3142fab6f7b527ce6c1bab93ecca521ff5762645dd57c421d"
}

Index toolkit files

Authorizations:

Bearer Token

query Parameters

search_expression	string Search by file name
toolkit_folder_id	integer Filter by toolkit folder ID
sort_by	string Sort by column: `created_at` `name`
direction	string Sort direction
page	integer Page number for pagination
items_per_page	integer Number of items per page

Responses

Response samples

200
401
403
422

Content type

application/json

{"collection": [{"id": 24,
"name": "document1.pdf",
"size": 177392,
"file_url": "http://minio:9000/caily-private/private_store/fb48394bfa912b2e40e757865ec5b452.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=minioadmin%2F20251205%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20251205T120641Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=8de0c944be65dde61758c28fefcec50914ebdaac9c70ee443728a93131306b1c"
},
{"id": 25,
"name": "image1.png",
"size": 177392,
"file_url": "http://minio:9000/caily-private/private_store/fb48394bfa912b2e40e757865ec5b452.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=minioadmin%2F20251205%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20251205T120641Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=8de0c944be65dde61758c28fefcec50914ebdaac9c70ee443728a93131306b1c"
},
{"id": 27,
"name": "presentation.pptx",
"size": 177392,
"file_url": "http://minio:9000/caily-private/private_store/fb48394bfa912b2e40e757865ec5b452.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=minioadmin%2F20251205%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20251205T120641Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=8de0c944be65dde61758c28fefcec50914ebdaac9c70ee443728a93131306b1c"
},
{"id": 26,
"name": "spreadsheet.xlsx",
"size": 177392,
"file_url": "http://minio:9000/caily-private/private_store/fb48394bfa912b2e40e757865ec5b452.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=minioadmin%2F20251205%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20251205T120641Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=8de0c944be65dde61758c28fefcec50914ebdaac9c70ee443728a93131306b1c"
}
],
"pagination": {"items_length": 4,
"page": 1,
"page_count": 1
}
}

Delete toolkit file

Authorizations:

Bearer Token

path Parameters

id

required

integer

Responses

Response samples

401
403
404
422

Content type

application/json

{"error": {"code": "unauthorized",
"details": [{"key": "_base",
"message": "Session has expired"
}
]
}
}

[CAILY_ADMIN] Toolkit Folders

Create toolkit folder

Authorizations:

Bearer Token

Request Body schema: application/json

name

required

string

Responses

Request samples

Payload

Content type

application/json

{"name": "string"
}

Response samples

201
401
403
422

Content type

application/json

{"id": 37,
"name": "My Toolkit Folder",
"toolkit_files_count": 0
}

Index toolkit folders

Authorizations:

Bearer Token

query Parameters

page	integer Page number for pagination
items_per_page	integer Number of items per page

Responses

Response samples

200
401
403

Content type

application/json

{"collection": [{"id": 42,
"name": "Folder 1",
"toolkit_files_count": 0
},
{"id": 43,
"name": "Folder 2",
"toolkit_files_count": 0
},
{"id": 44,
"name": "Folder 3",
"toolkit_files_count": 0
}
],
"pagination": {"items_length": 3,
"page": 1,
"page_count": 1
}
}

Delete toolkit folder

Authorizations:

Bearer Token

path Parameters

id

required

integer

Toolkit Folder ID

Responses

Response samples

401
403
404

Content type

application/json

{"error": {"code": "unauthorized",
"details": [{"key": "_base",
"message": "Session has expired"
}
]
}
}

Update toolkit folder

Authorizations:

Bearer Token

path Parameters

id

required

integer

Toolkit Folder ID

Request Body schema: application/json

name

required

string

Responses

Request samples

Payload

Content type

application/json

{"name": "string"
}

Response samples

200
401
403
404
422

Content type

application/json

{"id": 51,
"name": "Updated Toolkit Folder",
"toolkit_files_count": 0
}

[MOBILE/WS] Notification bell channel

Notification bell channel

The actual uri of the websocket is: wss://{{base_url}}/cable?token={{token}}.

The purpose of this page is to show how to connect, subscribe to the channel and what it broadcasts.

Authorizations:

Token in query

query Parameters

token

required

string

Responses

Response samples

200

Content type

application/json

{"unread_notifications_count": 1
}

[INTERNAL] Caily app configuration

List Caily app configuration

Authorizations:

Bearer Token

Responses

Response samples

200

Content type

application/json

{"b2c_free_trial_period": 7,
"min_app_version": "1.0.0",
"latest_app_version": "1.2.0",
"callback_success_urls": {"stripe": "/home"
}
}

[COMMON] Calendar Entries

Delete calendar entry

Authorizations:

Bearer Token

path Parameters

id

required

integer

Responses

Response samples

401
403
404
422

Content type

application/json

{"error": {"code": "unauthorized",
"details": [{"key": "_base",
"message": "Session has expired"
}
]
}
}

Show calendar entry

Authorizations:

Bearer Token

path Parameters

id

required

integer

Responses

Response samples

200
401
403
404
422

Content type

application/json

{"id": 13,
"starts_at": "2025-12-05T13:06:42.641947Z",
"ends_at": "2025-12-05T14:06:42.641964Z",
"completed": false,
"location": null,
"notes": null,
"assignee": null,
"periodic_event": {"id": 7,
"created_at": "2025-12-05T12:06:42.640036Z",
"event_type": "event",
"name": "et",
"notes": "Fugiat at et enim.",
"is_private": false,
"alarm_before_minutes": null,
"is_all_day": false,
"location": null,
"periodicity_type": "interval",
"periodicity_dow": null,
"periodicity_interval": "daily",
"start_date": "2025-12-05",
"end_date": "2025-12-05",
"start_hour": "10:00",
"end_hour": "11:00",
"hours": null,
"time_zone": "UTC",
"series_end_date": null,
"dosage": null,
"vital_sign_measurement_type": null,
"adl_type": null,
"assignee": null,
"vault_content_calendar_display": null,
"files": [ ]
}
}

Update event calendar entry

Authorizations:

Bearer Token

path Parameters

id

required

integer

Request Body schema: application/json

starts_at	string <date-time> To update time, both starts_at and ends_at are required, Max 5 years in the future
ends_at	string <date-time> To update time, both starts_at and ends_at are required, Max 24 hours between starts_at and ends_at, Max 5 years in the future
completed	boolean
notes	string or null
assignee_id	integer or null
	object or null

Responses

Request samples

Payload

Content type

application/json

{"starts_at": "2019-08-24T14:15:22Z",
"ends_at": "2019-08-24T14:15:22Z",
"completed": true,
"notes": "string",
"assignee_id": 0,
"location": {"place_id": "string",
"name": "string"
}
}

Response samples

200
401
403
404
422

Content type

application/json

{"id": 19,
"starts_at": "2025-12-05T13:06:43.000000Z",
"ends_at": "2025-12-05T14:06:43.000000Z",
"completed": false,
"location": {"place_id": "ChIJN1t_tDeuEmsRUsoyG83frY4",
"name": "Googleplex"
},
"notes": "Updated notes",
"assignee": null,
"periodic_event": {"id": 13,
"created_at": "2025-12-05T12:06:42.984349Z",
"event_type": "event",
"name": "qui",
"notes": "Perspiciatis blanditiis voluptatibus pariatur.",
"is_private": false,
"alarm_before_minutes": null,
"is_all_day": false,
"location": null,
"periodicity_type": "interval",
"periodicity_dow": null,
"periodicity_interval": "daily",
"start_date": "2025-12-05",
"end_date": "2025-12-05",
"start_hour": "10:00",
"end_hour": "11:00",
"hours": null,
"time_zone": "UTC",
"series_end_date": null,
"dosage": null,
"vital_sign_measurement_type": null,
"adl_type": null,
"assignee": null,
"vault_content_calendar_display": null,
"files": [ ]
}
}

Update habit calendar entry

Authorizations:

Bearer Token

path Parameters

id

required

integer

Request Body schema: application/json

starts_at	string <date-time> To update time, both starts_at and ends_at are required, Max 5 years in the future
completed	boolean Can be updated only if habit has no adl or vital sign measurement type
notes	string or null
assignee_id	integer or null

Responses

Request samples

Payload

Content type

application/json

{"starts_at": "2019-08-24T14:15:22Z",
"completed": true,
"notes": "string",
"assignee_id": 0
}

Response samples

200
401
403
404
422

Content type

application/json

{"id": 30,
"starts_at": "2025-12-05T13:06:43.000000Z",
"ends_at": "2025-12-05T13:21:43.000000Z",
"completed": false,
"location": null,
"notes": "Updated notes",
"assignee": null,
"periodic_event": {"id": 24,
"created_at": "2025-12-05T12:06:43.559172Z",
"event_type": "habit",
"name": "quis",
"notes": "Et reprehenderit rerum eveniet.",
"is_private": false,
"alarm_before_minutes": null,
"is_all_day": false,
"location": null,
"periodicity_type": "day_of_week",
"periodicity_dow": [0
],
"periodicity_interval": "daily",
"start_date": "2025-12-04",
"end_date": "2025-12-04",
"start_hour": "10:00",
"end_hour": "11:00",
"hours": null,
"time_zone": "UTC",
"series_end_date": null,
"dosage": null,
"vital_sign_measurement_type": null,
"adl_type": null,
"assignee": null,
"vault_content_calendar_display": null,
"files": [ ]
}
}

Update medication calendar entry

Authorizations:

Bearer Token

path Parameters

id

required

integer

Request Body schema: application/json

starts_at	string <date-time> To update time, both starts_at and ends_at are required, Max 5 years in the future
completed	boolean
notes	string or null
assignee_id	integer or null

Responses

Request samples

Payload

Content type

application/json

{"starts_at": "2019-08-24T14:15:22Z",
"completed": true,
"notes": "string",
"assignee_id": 0
}

Response samples

200
401
403
404
422

Content type

application/json

{"id": 40,
"starts_at": "2025-12-05T13:06:44.000000Z",
"ends_at": "2025-12-05T13:21:44.000000Z",
"completed": false,
"location": null,
"notes": "Updated notes",
"assignee": null,
"periodic_event": {"id": 34,
"created_at": "2025-12-05T12:06:44.090046Z",
"event_type": "medication",
"name": "atque",
"notes": "Ratione expedita at reiciendis.",
"is_private": false,
"alarm_before_minutes": null,
"is_all_day": false,
"location": null,
"periodicity_type": "interval",
"periodicity_dow": null,
"periodicity_interval": "daily",
"start_date": "2025-12-04",
"end_date": "2025-12-04",
"start_hour": "10:00",
"end_hour": "11:00",
"hours": null,
"time_zone": "UTC",
"series_end_date": null,
"dosage": null,
"vital_sign_measurement_type": null,
"adl_type": null,
"assignee": null,
"vault_content_calendar_display": null,
"files": [ ]
}
}

Update task calendar entry

Authorizations:

Bearer Token

path Parameters

id

required

integer

Request Body schema: application/json

completed

boolean

Responses

Request samples

Payload

Content type

application/json

{"completed": true
}

Response samples

200
401
403
404
422

Content type

application/json

{"id": 49,
"starts_at": "2025-12-05T13:06:44.515901Z",
"ends_at": "2025-12-05T14:06:44.515915Z",
"completed": true,
"location": null,
"notes": null,
"assignee": null,
"periodic_event": {"id": 43,
"created_at": "2025-12-05T12:06:44.511665Z",
"event_type": "task",
"name": "omnis",
"notes": "Aut facilis itaque qui.",
"is_private": false,
"alarm_before_minutes": null,
"is_all_day": false,
"location": null,
"periodicity_type": "interval",
"periodicity_dow": null,
"periodicity_interval": "daily",
"start_date": "2025-12-05",
"end_date": "2025-12-05",
"start_hour": "10:00",
"end_hour": "11:00",
"hours": null,
"time_zone": "UTC",
"series_end_date": null,
"dosage": null,
"vital_sign_measurement_type": null,
"adl_type": null,
"assignee": null,
"vault_content_calendar_display": null,
"files": [ ]
}
}

[COMMON] Care facilities

Get care facilities

Authorizations:

Bearer Token

query Parameters

search_expression	string
page	integer
items_per_page	integer

Responses

Response samples

200
401
422

Content type

application/json

Example

when ehr_test_diagnostic_reports feature flag is disabled for the user

{"collection": [{"id": 2,
"name": "Thompson, Lowe and Wunsch",
"address": "278 Emmerich Vista South Kam Indiana 24360 HK",
"oauth_redirect_url": "https://example.com/oauth/authorize"
}
],
"pagination": {"items_length": 1,
"page": 1,
"page_count": 1
}
}

[COMMON] Carereceiver documentations

Update carereceiver documentation

Authorizations:

Bearer Token

Request Body schema: application/json

circle_id	integer Circle ID
	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"circle_id": 0,
"carereceiver_documentation": [{"name": "string",
"subcategories": ["string"
]
}
]
}

Response samples

200
401
403
404
422

Content type

application/json

[{"id": 1,
"name": "Category 1",
"carereceiver_documentation_subcategories": [{"id": 1,
"name": "Subcategory 1"
},
{"id": 2,
"name": "Subcategory 2"
}
]
},
{"id": 2,
"name": "Category 2",
"carereceiver_documentation_subcategories": [{"id": 3,
"name": "Subcategory 3"
},
{"id": 4,
"name": "Subcategory 4"
},
{"id": 5,
"name": "Subcategory 5"
}
]
}
]

[COMMON] Chat Files

Create a chat file

Authorizations:

Bearer Token

Request Body schema: multipart/form-data
required

Chat ID

integer

Responses

Response samples

201
401
403
404
422

Content type

application/json

{"id": 1,
"name": "example-image.png",
"size": 10079,
"url": "http://minio:9000/caily-private/private_store/chat_file/1/example-image-1.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=minioadmin%2F20251205%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20251205T120646Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=3f9064357342ca98bef6d4691cfd11238a52e8d78dbf756329c7a9f3d3422d17",
"created_at": "2025-12-05T12:06:45.813306Z",
"chat_id": 1,
"chat_message_id": null
}

Delete a chat file

Authorizations:

Bearer Token

path Parameters

id

required

integer

Chat file ID

Responses

Response samples

401
403
404
422

Content type

application/json

{"error": {"code": "unauthorized",
"details": [{"key": "_base",
"message": "Session has expired"
}
]
}
}

[COMMON] Chat Messages

Create a chat message

Authorizations:

Bearer Token

Request Body schema: application/json

chat_id	integer
circle_id	integer
member_user_ids	Array of integers
content required	string
file_ids	Array of integers

Responses

Request samples

Payload

Content type

application/json

{"chat_id": 0,
"circle_id": 0,
"member_user_ids": [0
],
"content": "string",
"file_ids": [0
]
}

Response samples

201
401
403
404
422

Content type

application/json

Example

Message created successfully

{"id": 1,
"content": "Hello world!",
"message_type": "regular",
"metadata": null,
"created_at": "2025-12-05T12:06:47.107126Z",
"chat_user_id": 15,
"user_id": 223,
"sender_name": "Lizzie Kemmer Rocco Hane I",
"sender_avatar_url": null,
"sender_placeholder_avatar_data": {"initials": "FF",
"background_color": "#FF0000"
},
"files": [ ]
}

List chat messages for a chat

Authorizations:

Bearer Token

query Parameters

chat_id required	integer
search_query	string
cursor	string
items_per_page	integer

Responses

Response samples

200
401
403
404
422

Content type

application/json

[{"id": 5,
"content": "How are you?",
"message_type": "regular",
"metadata": { },
"created_at": "2025-12-05T12:06:48.034210Z",
"chat_user_id": 27,
"user_id": 246,
"sender_name": "Christoper Stamm Savanna Kreiger",
"sender_avatar_url": null,
"sender_placeholder_avatar_data": {"initials": "FF",
"background_color": "#FF0000"
},
"files": [ ]
},
{"id": 4,
"content": "Hello world",
"message_type": "regular",
"metadata": { },
"created_at": "2025-12-05T12:06:48.032591Z",
"chat_user_id": 27,
"user_id": 246,
"sender_name": "Christoper Stamm Savanna Kreiger",
"sender_avatar_url": null,
"sender_placeholder_avatar_data": {"initials": "FF",
"background_color": "#FF0000"
},
"files": [ ]
}
]

[COMMON] Chat Users

Add users to chat

Authorizations:

Bearer Token

Request Body schema: application/json

chat_id required	integer
user_ids required	Array of integers Array of user IDs to add to the chat

Responses

Request samples

Payload

Content type

application/json

{"chat_id": 0,
"user_ids": [0
]
}

Response samples

201
401
403
404
422

Content type

application/json

Example

Users added to chat successfully

{"id": 34,
"circle_id": 84,
"created_by_id": 257,
"last_message_at": "2025-12-05T12:06:48.244166Z",
"last_message": "Rev. Damon Wunsch Harrison Schulist added Mrs. Katrice Cremin Linnea Yundt to the chat",
"last_message_type": "system",
"created_at": "2025-12-05T12:06:48.217071Z",
"updated_at": "2025-12-05T12:06:48.217071Z",
"active_users_count": 2,
"members": [{"id": 32,
"chat_id": 34,
"user_id": 257,
"active": true,
"muted": false,
"last_seen_at": null,
"created_at": "2025-12-05T12:06:48.218647Z",
"updated_at": "2025-12-05T12:06:48.218647Z",
"user_first_name": "Rev. Damon Wunsch",
"user_last_name": "Harrison Schulist",
"user_avatar_url": null,
"user_placeholder_avatar_data": {"initials": "FF",
"background_color": "#FF0000"
}
},
{"id": 33,
"chat_id": 34,
"user_id": 259,
"active": true,
"muted": false,
"last_seen_at": null,
"created_at": "2025-12-05T12:06:48.242696Z",
"updated_at": "2025-12-05T12:06:48.242696Z",
"user_first_name": "Mrs. Katrice Cremin",
"user_last_name": "Linnea Yundt",
"user_avatar_url": null,
"user_placeholder_avatar_data": {"initials": "FF",
"background_color": "#FF0000"
}
}
],
"current_user_last_seen_at": null
}

Remove user from chat

Authorizations:

Bearer Token

path Parameters

chat_id required	integer
user_id required	integer

Responses

Response samples

200
401
403
404
422

Content type

application/json

Example

User removed from chat successfully

{"id": 45,
"circle_id": 94,
"created_by_id": 290,
"last_message_at": "2025-12-05T12:06:48.766340Z",
"last_message": "Hobert Schroeder Hallie Feest removed Rea Bergnaum Monte Pacocha Sr. from the chat",
"last_message_type": "system",
"created_at": "2025-12-05T12:06:48.737990Z",
"updated_at": "2025-12-05T12:06:48.737990Z",
"active_users_count": 1,
"members": [{"id": 45,
"chat_id": 45,
"user_id": 290,
"active": true,
"muted": false,
"last_seen_at": null,
"created_at": "2025-12-05T12:06:48.739843Z",
"updated_at": "2025-12-05T12:06:48.739843Z",
"user_first_name": "Hobert Schroeder",
"user_last_name": "Hallie Feest",
"user_avatar_url": null,
"user_placeholder_avatar_data": {"initials": "FF",
"background_color": "#FF0000"
}
}
],
"current_user_last_seen_at": null
}

Toggle mute status for a chat

Authorizations:

Bearer Token

path Parameters

chat_id

required

integer

Chat ID

Responses

Response samples

200
401
404
422

Content type

application/json

{"id": 59,
"chat_id": 53,
"user_id": 313,
"active": true,
"muted": true,
"last_seen_at": null,
"created_at": "2025-12-05T12:06:49.080833Z",
"updated_at": "2025-12-05T12:06:49.092353Z",
"user_first_name": "Irwin Larkin",
"user_last_name": "Afton Brekke",
"user_avatar_url": null,
"user_placeholder_avatar_data": {"initials": "FF",
"background_color": "#FF0000"
}
}

[COMMON] Chats

List chats for a circle

Authorizations:

Bearer Token

query Parameters

circle_id required	integer
search_query	string
cursor	string
items_per_page	integer

Responses

Response samples

200
401
403
404
422

Content type

application/json

[{"id": 61,
"circle_id": 108,
"created_by_id": 328,
"last_message_at": "2025-12-05T11:06:49.463271Z",
"last_message": null,
"last_message_type": null,
"created_at": "2025-12-05T12:06:49.463554Z",
"updated_at": "2025-12-05T12:06:49.463554Z",
"active_users_count": 1,
"members": [{"id": 66,
"chat_id": 61,
"user_id": 328,
"active": true,
"muted": false,
"last_seen_at": null,
"created_at": "2025-12-05T12:06:49.467895Z",
"updated_at": "2025-12-05T12:06:49.467895Z",
"user_first_name": "Ingeborg Weissnat DC",
"user_last_name": "Aron Schimmel JD",
"user_avatar_url": null,
"user_placeholder_avatar_data": {"initials": "FF",
"background_color": "#FF0000"
}
}
],
"current_user_last_seen_at": null
}
]

Show chat

Authorizations:

Bearer Token

path Parameters

chat_id

required

integer

Responses

Response samples

200
401
403
404
422

Content type

application/json

{"id": 66,
"circle_id": 114,
"created_by_id": 338,
"last_message_at": "2025-12-05T11:06:49.667988Z",
"last_message": null,
"last_message_type": null,
"created_at": "2025-12-05T12:06:49.668147Z",
"updated_at": "2025-12-05T12:06:49.668147Z",
"active_users_count": 1,
"members": [{"id": 71,
"chat_id": 66,
"user_id": 338,
"active": true,
"muted": false,
"last_seen_at": null,
"created_at": "2025-12-05T12:06:49.669964Z",
"updated_at": "2025-12-05T12:06:49.669964Z",
"user_first_name": "Mr. Georgiann Torp",
"user_last_name": "Brock Mohr Sr.",
"user_avatar_url": null,
"user_placeholder_avatar_data": {"initials": "FF",
"background_color": "#FF0000"
}
}
],
"current_user_last_seen_at": null
}

[COMMON] Circle Invitations

Accept circle's join invitation

Authorizations:

Bearer Token

Request Body schema: application/json

invitation_token

required

string

Responses

Request samples

Payload

Content type

application/json

{"invitation_token": "string"
}

Response samples

404
422

Content type

application/json

{"error": {"code": "fetch_circle",
"details": [{"key": "_base",
"message": "Circle not found"
}
]
}
}

Get circle's circle invitations

Authorizations:

Bearer Token

query Parameters

circle_id

integer

Responses

Response samples

200
401
403
404
422

Content type

application/json

[{"user_id": 366,
"first_name": "Mohammed Feil I",
"last_name": "Matthew O'Conner",
"user_email": "user366@example.com",
"avatar_url": null,
"created_at": "2025-12-05T12:06:50.162355Z",
"circle_invitation_id": 6,
"placeholder_avatar_data": {"initials": "FF",
"background_color": "#FF0000"
},
"invited_email": "user366@example.com",
"circle_role": "patient"
}
]

Reject circle's join invitation by id

Authorizations:

Bearer Token

Request Body schema: application/json

id

required

integer

Responses

Request samples

Payload

Content type

application/json

{"id": 0
}

Response samples

401
404
422

Content type

application/json

{"error": {"code": "unauthorized",
"details": [{"key": "_base",
"message": "Session has expired"
}
]
}
}

Reject circle's join invitation by invitation token

Authorizations:

Bearer Token

Request Body schema: application/json

invitation_token

required

string

Responses

Request samples

Payload

Content type

application/json

{"invitation_token": "string"
}

Response samples

401
404
422

Content type

application/json

{"error": {"code": "unauthorized",
"details": [{"key": "_base",
"message": "Session has expired"
}
]
}
}

Get single circle invitation

Authorizations:

Bearer Token

query Parameters

invitation_token

string

Responses

Response samples

200
401
404
422

Content type

application/json

{"id": 22,
"circle_id": 141,
"circle_name": "Matthew Abernathy",
"members_count": 1,
"avatar_url": null,
"placeholder_avatar_data": {"initials": "JD",
"background_color": "#000000"
},
"circle_role": "patient"
}

Withdraw circle's join invitation

Authorizations:

Bearer Token

path Parameters

id

required

integer

Responses

Response samples

401
403
404
422

Content type

application/json

{"error": {"code": "unauthorized",
"details": [{"key": "_base",
"message": "Session has expired"
}
]
}
}

[COMMON] Circle Memberships

Destroy single membership

Authorizations:

Bearer Token

path Parameters

id

required

integer

Responses

Response samples

401
403
404
422

Content type

application/json

{"error": {"code": "unauthorized",
"details": [{"key": "_base",
"message": "Session has expired"
}
]
}
}

Show single membership

Authorizations:

Bearer Token

path Parameters

id

required

integer

Responses

Response samples

200
401
403
404
422

Content type

application/json

{"id": 326,
"avatar_url": null,
"first_name": "Mina Reichert",
"last_name": "Ching Bayer",
"email": "user462@example.com",
"birthday": "1998-08-17",
"roles": ["admin"
],
"placeholder_avatar_data": {"initials": "FF",
"background_color": "#FF0000"
}
}

Update circle membership

Authorizations:

Bearer Token

path Parameters

id

required

integer

Request Body schema: application/json

role	string Enum: "caregiver" "friends_and_family" "admin"

Responses

Request samples

Payload

Content type

application/json

{"role": "caregiver"
}

Response samples

200
401
403
404
422

Content type

application/json

{"id": 333,
"avatar_url": null,
"first_name": "Msgr. Dwight Okuneva",
"last_name": "Miss Willena Schamberger",
"email": "user474@example.com",
"birthday": "1979-11-13",
"roles": ["admin",
"caregiver"
],
"placeholder_avatar_data": {"initials": "FF",
"background_color": "#FF0000"
}
}

Index circle's memberships

Authorizations:

Bearer Token

query Parameters

circle_id required	integer
chat_id	integer

Responses

Response samples

200
401
403
404
422

Content type

application/json

Example

index circle's memberships

[{"id": 434,
"membership_id": 307,
"avatar_url": null,
"first_name": "Pasquale Rolfson",
"last_name": "Josefa Reilly",
"email": "user434@example.com",
"birthday": "1974-12-30",
"roles": ["caregiver"
],
"placeholder_avatar_data": {"initials": "FF",
"background_color": "#FF0000"
}
},
{"id": 435,
"membership_id": 305,
"avatar_url": null,
"first_name": "Al Johns LLD",
"last_name": "Riley Pfannerstill DVM",
"email": "user435@example.com",
"birthday": "1962-01-30",
"roles": ["admin"
],
"placeholder_avatar_data": {"initials": "FF",
"background_color": "#FF0000"
}
},
{"id": 436,
"membership_id": 306,
"avatar_url": null,
"first_name": "Elden Turner",
"last_name": "Terrie Murazik",
"email": "user436@example.com",
"birthday": "1964-12-06",
"roles": ["caregiver"
],
"placeholder_avatar_data": {"initials": "FF",
"background_color": "#FF0000"
}
}
]

[COMMON] Circle Requests

Accept circle's join request

Authorizations:

Bearer Token

path Parameters

id

required

integer

Request Body schema: application/json

role

required

string

Enum: "caregiver" "friends_and_family" "admin"

Responses

Request samples

Payload

Content type

application/json

{"role": "caregiver"
}

Response samples

401
403
404
422

Content type

application/json

{"error": {"code": "unauthorized",
"details": [{"key": "_base",
"message": "Session has expired"
}
]
}
}

Index circle's join requests

Authorizations:

Bearer Token

query Parameters

circle_id

required

integer

Responses

Response samples

200
401
403
404
422

Content type

application/json

[{"id": 502,
"email": "user502@example.com",
"first_name": "Branda O'Conner",
"last_name": "Sen. Dylan Nitzsche",
"avatar_url": null,
"created_at": "2025-12-05T12:06:52.657812Z",
"circle_request_id": 9,
"placeholder_avatar_data": {"initials": "FF",
"background_color": "#FF0000"
}
}
]

Reject circle's join request

Authorizations:

Bearer Token

path Parameters

id

required

integer

Responses

Response samples

401
403
404
422

Content type

application/json

{"error": {"code": "unauthorized",
"details": [{"key": "_base",
"message": "Session has expired"
}
]
}
}

[COMMON] Circle Symptoms

Create circle symptom

Authorizations:

Bearer Token

path Parameters

circle_id

required

integer

Request Body schema: application/json

symptom_id	integer
name	string <date_time>

Responses

Request samples

Payload

Content type

application/json

{"symptom_id": 0,
"name": "string"
}

Response samples

201
401
403
404
422

Content type

application/json

{"id": 1,
"symptom": {"id": 1,
"name": "aut"
},
"name": null
}

Index circle symptoms

Authorizations:

Bearer Token

path Parameters

circle_id

required

integer

Responses

Response samples

200
401
403
404
422

Content type

application/json

[ ]

Destroy circle symptom

Authorizations:

Bearer Token

path Parameters

id

required

integer

Circle Symptom ID

Responses

Response samples

401
403
404
422

Content type

application/json

{"error": {"code": "unauthorized",
"details": [{"key": "_base",
"message": "Session has expired"
}
]
}
}

Update circle symptom

Authorizations:

Bearer Token

path Parameters

id

required

integer

Circle Symptom ID

Request Body schema: application/json

name	string Name of the circle symptom

Responses

Request samples

Payload

Content type

application/json

{"name": "string"
}

Response samples

200
401
403
404
422

Content type

application/json

{"id": 9,
"symptom": null,
"name": "Name"
}

[COMMON] Circles

List care facilities

Authorizations:

Bearer Token

path Parameters

id

required

integer

Responses

Response samples

200
401
403
404
422

Content type

application/json

Example

when ehr_test_diagnostic_reports feature flag is disabled for the user

[{"id": 3,
"name": "Care Facility 1",
"address": "138 Richie Plaza Roscoeburgh Arkansas 27209-0339 MD",
"oauth_redirect_url": "https://example.com/oauth/authorize",
"care_facility": {"id": 8,
"name": "Care Facility 1"
},
"updated_at": "2025-12-05T12:06:54.174282Z"
}
]

List carereceiver documentation

Authorizations:

Bearer Token

path Parameters

id

required

integer

Responses

Response samples

200
401
403
404
422

Content type

application/json

[ ]

Get circle's contacts

Authorizations:

Bearer Token

path Parameters

id

required

integer

Responses

Response samples

200
401
403
404
422

Content type

application/json

[{"id": 2,
"name": "Gavin Kilback",
"email": "kory@bogan.test",
"phone_number": null,
"notes": "Et ad nam impedit.",
"category": null
},
{"id": 1,
"name": "Leonardo Stokes",
"email": "ellis@jaskolski.test",
"phone_number": null,
"notes": "Ex sit enim totam.",
"category": null
},
{"id": 3,
"name": "Miss Regenia Kshlerin",
"email": "alecia_mertz@bechtelar.test",
"phone_number": null,
"notes": "Ut enim ut mollitia.",
"category": null
}
]

Create circle

Authorizations:

Bearer Token

Request Body schema: multipart/form-data

name required	string
role required	string Enum: "admin" "patient" "caregiver" "friends_and_family"
avatar	string or null <binary>
time_zone	string Enum: "Africa/Abidjan" "Africa/Accra" "Africa/Addis_Ababa" "Africa/Algiers" "Africa/Asmara" "Africa/Bamako" "Africa/Bangui" "Africa/Banjul" "Africa/Bissau" "Africa/Blantyre" "Africa/Brazzaville" "Africa/Bujumbura" "Africa/Cairo" "Africa/Casablanca" "Africa/Ceuta" "Africa/Conakry" "Africa/Dakar" "Africa/Dar_es_Salaam" "Africa/Djibouti" "Africa/Douala" "Africa/El_Aaiun" "Africa/Freetown" "Africa/Gaborone" "Africa/Harare" "Africa/Johannesburg" "Africa/Juba" "Africa/Kampala" "Africa/Khartoum" "Africa/Kigali" "Africa/Kinshasa" "Africa/Lagos" "Africa/Libreville" "Africa/Lome" "Africa/Luanda" "Africa/Lubumbashi" "Africa/Lusaka" "Africa/Malabo" "Africa/Maputo" "Africa/Maseru" "Africa/Mbabane" "Africa/Mogadishu" "Africa/Monrovia" "Africa/Nairobi" "Africa/Ndjamena" "Africa/Niamey" "Africa/Nouakchott" "Africa/Ouagadougou" "Africa/Porto-Novo" "Africa/Sao_Tome" "Africa/Timbuktu" "Africa/Tripoli" "Africa/Tunis" "Africa/Windhoek" "America/Adak" "America/Anchorage" "America/Anguilla" "America/Antigua" "America/Araguaina" "America/Argentina/Buenos_Aires" "America/Argentina/Catamarca" "America/Argentina/Cordoba" "America/Argentina/Jujuy" "America/Argentina/La_Rioja" "America/Argentina/Mendoza" "America/Argentina/Rio_Gallegos" "America/Argentina/Salta" "America/Argentina/San_Juan" "America/Argentina/San_Luis" "America/Argentina/Tucuman" "America/Argentina/Ushuaia" "America/Aruba" "America/Asuncion" "America/Atikokan" "America/Atka" "America/Bahia" "America/Bahia_Banderas" "America/Barbados" "America/Belem" "America/Belize" "America/Blanc-Sablon" "America/Boa_Vista" "America/Bogota" "America/Boise" "America/Cambridge_Bay" "America/Campo_Grande" "America/Cancun" "America/Caracas" "America/Cayenne" "America/Cayman" "America/Chicago" "America/Chihuahua" "America/Ciudad_Juarez" "America/Coral_Harbour" "America/Costa_Rica" "America/Creston" "America/Cuiaba" "America/Curacao" "America/Danmarkshavn" "America/Dawson" "America/Dawson_Creek" "America/Denver" "America/Detroit" "America/Dominica" "America/Edmonton" "America/Eirunepe" "America/El_Salvador" "America/Ensenada" "America/Fort_Nelson" "America/Fortaleza" "America/Glace_Bay" "America/Goose_Bay" "America/Grand_Turk" "America/Grenada" "America/Guadeloupe" "America/Guatemala" "America/Guayaquil" "America/Guyana" "America/Halifax" "America/Havana" "America/Hermosillo" "America/Indiana/Indianapolis" "America/Indiana/Knox" "America/Indiana/Marengo" "America/Indiana/Petersburg" "America/Indiana/Tell_City" "America/Indiana/Vevay" "America/Indiana/Vincennes" "America/Indiana/Winamac" "America/Inuvik" "America/Iqaluit" "America/Jamaica" "America/Juneau" "America/Kentucky/Louisville" "America/Kentucky/Monticello" "America/Kralendijk" "America/La_Paz" "America/Lima" "America/Los_Angeles" "America/Lower_Princes" "America/Maceio" "America/Managua" "America/Manaus" "America/Marigot" "America/Martinique" "America/Matamoros" "America/Mazatlan" "America/Menominee" "America/Merida" "America/Metlakatla" "America/Mexico_City" "America/Miquelon" "America/Moncton" "America/Monterrey" "America/Montevideo" "America/Montreal" "America/Montserrat" "America/Nassau" "America/New_York" "America/Nipigon" "America/Nome" "America/Noronha" "America/North_Dakota/Beulah" "America/North_Dakota/Center" "America/North_Dakota/New_Salem" "America/Nuuk" "America/Ojinaga" "America/Panama" "America/Pangnirtung" "America/Paramaribo" "America/Phoenix" "America/Port-au-Prince" "America/Port_of_Spain" "America/Porto_Acre" "America/Porto_Velho" "America/Puerto_Rico" "America/Punta_Arenas" "America/Rainy_River" "America/Rankin_Inlet" "America/Recife" "America/Regina" "America/Resolute" "America/Rio_Branco" "America/Santa_Isabel" "America/Santarem" "America/Santiago" "America/Santo_Domingo" "America/Sao_Paulo" "America/Scoresbysund" "America/Shiprock" "America/Sitka" "America/St_Barthelemy" "America/St_Johns" "America/St_Kitts" "America/St_Lucia" "America/St_Thomas" "America/St_Vincent" "America/Swift_Current" "America/Tegucigalpa" "America/Thule" "America/Thunder_Bay" "America/Tijuana" "America/Toronto" "America/Tortola" "America/Vancouver" "America/Virgin" "America/Whitehorse" "America/Winnipeg" "America/Yakutat" "America/Yellowknife" "Antarctica/Casey" "Antarctica/Davis" "Antarctica/DumontDUrville" "Antarctica/Macquarie" "Antarctica/Mawson" "Antarctica/McMurdo" "Antarctica/Palmer" "Antarctica/Rothera" "Antarctica/Syowa" "Antarctica/Troll" "Antarctica/Vostok" "Arctic/Longyearbyen" "Asia/Aden" "Asia/Almaty" "Asia/Amman" "Asia/Anadyr" "Asia/Aqtau" "Asia/Aqtobe" "Asia/Ashgabat" "Asia/Atyrau" "Asia/Baghdad" "Asia/Bahrain" "Asia/Baku" "Asia/Bangkok" "Asia/Barnaul" "Asia/Beirut" "Asia/Bishkek" "Asia/Brunei" "Asia/Chita" "Asia/Chongqing" "Asia/Colombo" "Asia/Damascus" "Asia/Dhaka" "Asia/Dili" "Asia/Dubai" "Asia/Dushanbe" "Asia/Famagusta" "Asia/Gaza" "Asia/Harbin" "Asia/Hebron" "Asia/Ho_Chi_Minh" "Asia/Hong_Kong" "Asia/Hovd" "Asia/Irkutsk" "Asia/Istanbul" "Asia/Jakarta" "Asia/Jayapura" "Asia/Jerusalem" "Asia/Kabul" "Asia/Kamchatka" "Asia/Karachi" "Asia/Kashgar" "Asia/Kathmandu" "Asia/Khandyga" "Asia/Kolkata" "Asia/Krasnoyarsk" "Asia/Kuala_Lumpur" "Asia/Kuching" "Asia/Kuwait" "Asia/Macau" "Asia/Magadan" "Asia/Makassar" "Asia/Manila" "Asia/Muscat" "Asia/Nicosia" "Asia/Novokuznetsk" "Asia/Novosibirsk" "Asia/Omsk" "Asia/Oral" "Asia/Phnom_Penh" "Asia/Pontianak" "Asia/Pyongyang" "Asia/Qatar" "Asia/Qostanay" "Asia/Qyzylorda" "Asia/Riyadh" "Asia/Sakhalin" "Asia/Samarkand" "Asia/Seoul" "Asia/Shanghai" "Asia/Singapore" "Asia/Srednekolymsk" "Asia/Taipei" "Asia/Tashkent" "Asia/Tbilisi" "Asia/Tehran" "Asia/Tel_Aviv" "Asia/Thimphu" "Asia/Tokyo" "Asia/Tomsk" "Asia/Ulaanbaatar" "Asia/Urumqi" "Asia/Ust-Nera" "Asia/Vientiane" "Asia/Vladivostok" "Asia/Yakutsk" "Asia/Yangon" "Asia/Yekaterinburg" "Asia/Yerevan" "Atlantic/Azores" "Atlantic/Bermuda" "Atlantic/Canary" "Atlantic/Cape_Verde" "Atlantic/Faroe" "Atlantic/Jan_Mayen" "Atlantic/Madeira" "Atlantic/Reykjavik" "Atlantic/South_Georgia" "Atlantic/St_Helena" "Atlantic/Stanley" "Australia/Adelaide" "Australia/Brisbane" "Australia/Broken_Hill" "Australia/Canberra" "Australia/Currie" "Australia/Darwin" "Australia/Eucla" "Australia/Hobart" "Australia/Lindeman" "Australia/Lord_Howe" "Australia/Melbourne" "Australia/Perth" "Australia/Sydney" "Australia/Yancowinna" "Etc/GMT" "Etc/GMT+0" "Etc/GMT+1" "Etc/GMT+10" "Etc/GMT+11" "Etc/GMT+12" "Etc/GMT+2" "Etc/GMT+3" "Etc/GMT+4" "Etc/GMT+5" "Etc/GMT+6" "Etc/GMT+7" "Etc/GMT+8" "Etc/GMT+9" "Etc/GMT-0" "Etc/GMT-1" "Etc/GMT-10" "Etc/GMT-11" "Etc/GMT-12" "Etc/GMT-13" "Etc/GMT-14" "Etc/GMT-2" "Etc/GMT-3" "Etc/GMT-4" "Etc/GMT-5" "Etc/GMT-6" "Etc/GMT-7" "Etc/GMT-8" "Etc/GMT-9" "Etc/GMT0" "Etc/Greenwich" "Etc/UCT" "Etc/UTC" "Etc/Universal" "Etc/Zulu" "Europe/Amsterdam" "Europe/Andorra" "Europe/Astrakhan" "Europe/Athens" "Europe/Belfast" "Europe/Belgrade" "Europe/Berlin" "Europe/Bratislava" "Europe/Brussels" "Europe/Bucharest" "Europe/Budapest" "Europe/Busingen" "Europe/Chisinau" "Europe/Copenhagen" "Europe/Dublin" "Europe/Gibraltar" "Europe/Guernsey" "Europe/Helsinki" "Europe/Isle_of_Man" "Europe/Istanbul" "Europe/Jersey" "Europe/Kaliningrad" "Europe/Kirov" "Europe/Kyiv" "Europe/Lisbon" "Europe/Ljubljana" "Europe/London" "Europe/Luxembourg" "Europe/Madrid" "Europe/Malta" "Europe/Mariehamn" "Europe/Minsk" "Europe/Monaco" "Europe/Moscow" "Europe/Nicosia" "Europe/Oslo" "Europe/Paris" "Europe/Podgorica" "Europe/Prague" "Europe/Riga" "Europe/Rome" "Europe/Samara" "Europe/San_Marino" "Europe/Sarajevo" "Europe/Saratov" "Europe/Simferopol" "Europe/Skopje" "Europe/Sofia" "Europe/Stockholm" "Europe/Tallinn" "Europe/Tirane" "Europe/Tiraspol" "Europe/Ulyanovsk" "Europe/Vaduz" "Europe/Vatican" "Europe/Vienna" "Europe/Vilnius" "Europe/Volgograd" "Europe/Warsaw" "Europe/Zagreb" "Europe/Zurich" "Factory" "GMT" "Indian/Antananarivo" "Indian/Chagos" "Indian/Christmas" "Indian/Cocos" "Indian/Comoro" "Indian/Kerguelen" "Indian/Mahe" "Indian/Maldives" "Indian/Mauritius" "Indian/Mayotte" "Indian/Reunion" "Pacific/Apia" "Pacific/Auckland" "Pacific/Bougainville" "Pacific/Chatham" "Pacific/Chuuk" "Pacific/Easter" "Pacific/Efate" "Pacific/Fakaofo" "Pacific/Fiji" "Pacific/Funafuti" "Pacific/Galapagos" "Pacific/Gambier" "Pacific/Guadalcanal" "Pacific/Guam" "Pacific/Honolulu" "Pacific/Johnston" "Pacific/Kanton" "Pacific/Kiritimati" "Pacific/Kosrae" "Pacific/Kwajalein" "Pacific/Majuro" "Pacific/Marquesas" "Pacific/Midway" "Pacific/Nauru" "Pacific/Niue" "Pacific/Norfolk" "Pacific/Noumea" "Pacific/Pago_Pago" "Pacific/Palau" "Pacific/Pitcairn" "Pacific/Pohnpei" "Pacific/Port_Moresby" "Pacific/Rarotonga" "Pacific/Saipan" "Pacific/Samoa" "Pacific/Tahiti" "Pacific/Tarawa" "Pacific/Tongatapu" "Pacific/Wake" "Pacific/Wallis" "Pacific/Yap" "UTC"
create_free_trial	boolean or null
	object

Responses

Request samples

Payload

Content type

multipart/form-data

{
  "name": "Example name",
  "role": "friends_and_family",
  "time_zone": "America/New_York",
  "patient": {
    "email": "john.doe@example.com",
    "first_name": "John",
    "last_name": "Doe",
    "birthday": "1985-05-03",
    "location": "Location"
  }
}

Response samples

201
401
422

Content type

application/json

{"id": 305,
"name": "My Circle",
"invitation_code": "123456",
"patient_first_name": "Patient Name",
"patient_last_name": "Patient Last Name",
"patient_email": "example@email.com",
"patient_birthday": "1990-01-01",
"patient_time_zone": "America/New_York",
"avatar_url": "http://minio:9000/caily-private/private_store/circle/305/example-image20251205-82-khew6e-305.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=minioadmin%2F20251205%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20251205T120655Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=e62b921485c5760ffe1e31ad036754622260988956e359f9c7e542880be11470",
"placeholder_avatar_data": {"initials": "PP",
"background_color": "#565A4A"
},
"patient_location": {"name": "Googleplex",
"place_id": "ChIJN1t_tDeuEmsRUsoyG83frY4"
},
"current_user_roles": ["friends_and_family",
"admin"
],
"is_current_user_personal_circle": false,
"current_user_permissions": [{"feature_type": "circle_center_profile",
"permission_type": "edit"
},
{"feature_type": "daily_check_ins",
"permission_type": "edit"
},
{"feature_type": "schedule",
"permission_type": "edit"
},
{"feature_type": "medications",
"permission_type": "edit"
},
{"feature_type": "notes",
"permission_type": "edit"
},
{"feature_type": "activities_of_daily_living",
"permission_type": "edit"
},
{"feature_type": "carereceiver_documentation",
"permission_type": "edit"
},
{"feature_type": "symptoms",
"permission_type": "edit"
},
{"feature_type": "last_wishes",
"permission_type": "edit"
},
{"feature_type": "storage_of_important_documents",
"permission_type": "edit"
},
{"feature_type": "medical_records",
"permission_type": "edit"
},
{"feature_type": "vital_signs",
"permission_type": "edit"
},
{"feature_type": "contacts",
"permission_type": "edit"
},
{"feature_type": "vault_forms",
"permission_type": "edit"
},
{"feature_type": "vault_folders",
"permission_type": "edit"
},
{"feature_type": "vault_documents",
"permission_type": "edit"
},
{"feature_type": "vault_tasks",
"permission_type": "edit"
}
],
"members_count": 1,
"daily_check_ins_enabled": true,
"current_subscription_plan": null,
"free_trial_available": true,
"is_pin_auth_required_for_health": true,
"is_pin_auth_required_for_vault": true,
"current_user_vault_form_permissions": [ ]
}

Get circle's daily check ins

Authorizations:

Bearer Token

path Parameters

id

required

integer

query Parameters

object

Responses

Response samples

200
401
403
404
422

Content type

application/json

[ ]

Get circle's daily check ins

Authorizations:

Bearer Token

path Parameters

id

required

integer

query Parameters

time_zone

string

Enum: "Africa/Abidjan" "Africa/Accra" "Africa/Addis_Ababa" "Africa/Algiers" "Africa/Asmara" "Africa/Bamako" "Africa/Bangui" "Africa/Banjul" "Africa/Bissau" "Africa/Blantyre" "Africa/Brazzaville" "Africa/Bujumbura" "Africa/Cairo" "Africa/Casablanca" "Africa/Ceuta" "Africa/Conakry" "Africa/Dakar" "Africa/Dar_es_Salaam" "Africa/Djibouti" "Africa/Douala" "Africa/El_Aaiun" "Africa/Freetown" "Africa/Gaborone" "Africa/Harare" "Africa/Johannesburg" "Africa/Juba" "Africa/Kampala" "Africa/Khartoum" "Africa/Kigali" "Africa/Kinshasa" "Africa/Lagos" "Africa/Libreville" "Africa/Lome" "Africa/Luanda" "Africa/Lubumbashi" "Africa/Lusaka" "Africa/Malabo" "Africa/Maputo" "Africa/Maseru" "Africa/Mbabane" "Africa/Mogadishu" "Africa/Monrovia" "Africa/Nairobi" "Africa/Ndjamena" "Africa/Niamey" "Africa/Nouakchott" "Africa/Ouagadougou" "Africa/Porto-Novo" "Africa/Sao_Tome" "Africa/Timbuktu" "Africa/Tripoli" "Africa/Tunis" "Africa/Windhoek" "America/Adak" "America/Anchorage" "America/Anguilla" "America/Antigua" "America/Araguaina" "America/Argentina/Buenos_Aires" "America/Argentina/Catamarca" "America/Argentina/Cordoba" "America/Argentina/Jujuy" "America/Argentina/La_Rioja" "America/Argentina/Mendoza" "America/Argentina/Rio_Gallegos" "America/Argentina/Salta" "America/Argentina/San_Juan" "America/Argentina/San_Luis" "America/Argentina/Tucuman" "America/Argentina/Ushuaia" "America/Aruba" "America/Asuncion" "America/Atikokan" "America/Atka" "America/Bahia" "America/Bahia_Banderas" "America/Barbados" "America/Belem" "America/Belize" "America/Blanc-Sablon" "America/Boa_Vista" "America/Bogota" "America/Boise" "America/Cambridge_Bay" "America/Campo_Grande" "America/Cancun" "America/Caracas" "America/Cayenne" "America/Cayman" "America/Chicago" "America/Chihuahua" "America/Ciudad_Juarez" "America/Coral_Harbour" "America/Costa_Rica" "America/Creston" "America/Cuiaba" "America/Curacao" "America/Danmarkshavn" "America/Dawson" "America/Dawson_Creek" "America/Denver" "America/Detroit" "America/Dominica" "America/Edmonton" "America/Eirunepe" "America/El_Salvador" "America/Ensenada" "America/Fort_Nelson" "America/Fortaleza" "America/Glace_Bay" "America/Goose_Bay" "America/Grand_Turk" "America/Grenada" "America/Guadeloupe" "America/Guatemala" "America/Guayaquil" "America/Guyana" "America/Halifax" "America/Havana" "America/Hermosillo" "America/Indiana/Indianapolis" "America/Indiana/Knox" "America/Indiana/Marengo" "America/Indiana/Petersburg" "America/Indiana/Tell_City" "America/Indiana/Vevay" "America/Indiana/Vincennes" "America/Indiana/Winamac" "America/Inuvik" "America/Iqaluit" "America/Jamaica" "America/Juneau" "America/Kentucky/Louisville" "America/Kentucky/Monticello" "America/Kralendijk" "America/La_Paz" "America/Lima" "America/Los_Angeles" "America/Lower_Princes" "America/Maceio" "America/Managua" "America/Manaus" "America/Marigot" "America/Martinique" "America/Matamoros" "America/Mazatlan" "America/Menominee" "America/Merida" "America/Metlakatla" "America/Mexico_City" "America/Miquelon" "America/Moncton" "America/Monterrey" "America/Montevideo" "America/Montreal" "America/Montserrat" "America/Nassau" "America/New_York" "America/Nipigon" "America/Nome" "America/Noronha" "America/North_Dakota/Beulah" "America/North_Dakota/Center" "America/North_Dakota/New_Salem" "America/Nuuk" "America/Ojinaga" "America/Panama" "America/Pangnirtung" "America/Paramaribo" "America/Phoenix" "America/Port-au-Prince" "America/Port_of_Spain" "America/Porto_Acre" "America/Porto_Velho" "America/Puerto_Rico" "America/Punta_Arenas" "America/Rainy_River" "America/Rankin_Inlet" "America/Recife" "America/Regina" "America/Resolute" "America/Rio_Branco" "America/Santa_Isabel" "America/Santarem" "America/Santiago" "America/Santo_Domingo" "America/Sao_Paulo" "America/Scoresbysund" "America/Shiprock" "America/Sitka" "America/St_Barthelemy" "America/St_Johns" "America/St_Kitts" "America/St_Lucia" "America/St_Thomas" "America/St_Vincent" "America/Swift_Current" "America/Tegucigalpa" "America/Thule" "America/Thunder_Bay" "America/Tijuana" "America/Toronto" "America/Tortola" "America/Vancouver" "America/Virgin" "America/Whitehorse" "America/Winnipeg" "America/Yakutat" "America/Yellowknife" "Antarctica/Casey" "Antarctica/Davis" "Antarctica/DumontDUrville" "Antarctica/Macquarie" "Antarctica/Mawson" "Antarctica/McMurdo" "Antarctica/Palmer" "Antarctica/Rothera" "Antarctica/Syowa" "Antarctica/Troll" "Antarctica/Vostok" "Arctic/Longyearbyen" "Asia/Aden" "Asia/Almaty" "Asia/Amman" "Asia/Anadyr" "Asia/Aqtau" "Asia/Aqtobe" "Asia/Ashgabat" "Asia/Atyrau" "Asia/Baghdad" "Asia/Bahrain" "Asia/Baku" "Asia/Bangkok" "Asia/Barnaul" "Asia/Beirut" "Asia/Bishkek" "Asia/Brunei" "Asia/Chita" "Asia/Chongqing" "Asia/Colombo" "Asia/Damascus" "Asia/Dhaka" "Asia/Dili" "Asia/Dubai" "Asia/Dushanbe" "Asia/Famagusta" "Asia/Gaza" "Asia/Harbin" "Asia/Hebron" "Asia/Ho_Chi_Minh" "Asia/Hong_Kong" "Asia/Hovd" "Asia/Irkutsk" "Asia/Istanbul" "Asia/Jakarta" "Asia/Jayapura" "Asia/Jerusalem" "Asia/Kabul" "Asia/Kamchatka" "Asia/Karachi" "Asia/Kashgar" "Asia/Kathmandu" "Asia/Khandyga" "Asia/Kolkata" "Asia/Krasnoyarsk" "Asia/Kuala_Lumpur" "Asia/Kuching" "Asia/Kuwait" "Asia/Macau" "Asia/Magadan" "Asia/Makassar" "Asia/Manila" "Asia/Muscat" "Asia/Nicosia" "Asia/Novokuznetsk" "Asia/Novosibirsk" "Asia/Omsk" "Asia/Oral" "Asia/Phnom_Penh" "Asia/Pontianak" "Asia/Pyongyang" "Asia/Qatar" "Asia/Qostanay" "Asia/Qyzylorda" "Asia/Riyadh" "Asia/Sakhalin" "Asia/Samarkand" "Asia/Seoul" "Asia/Shanghai" "Asia/Singapore" "Asia/Srednekolymsk" "Asia/Taipei" "Asia/Tashkent" "Asia/Tbilisi" "Asia/Tehran" "Asia/Tel_Aviv" "Asia/Thimphu" "Asia/Tokyo" "Asia/Tomsk" "Asia/Ulaanbaatar" "Asia/Urumqi" "Asia/Ust-Nera" "Asia/Vientiane" "Asia/Vladivostok" "Asia/Yakutsk" "Asia/Yangon" "Asia/Yekaterinburg" "Asia/Yerevan" "Atlantic/Azores" "Atlantic/Bermuda" "Atlantic/Canary" "Atlantic/Cape_Verde" "Atlantic/Faroe" "Atlantic/Jan_Mayen" "Atlantic/Madeira" "Atlantic/Reykjavik" "Atlantic/South_Georgia" "Atlantic/St_Helena" "Atlantic/Stanley" "Australia/Adelaide" "Australia/Brisbane" "Australia/Broken_Hill" "Australia/Canberra" "Australia/Currie" "Australia/Darwin" "Australia/Eucla" "Australia/Hobart" "Australia/Lindeman" "Australia/Lord_Howe" "Australia/Melbourne" "Australia/Perth" "Australia/Sydney" "Australia/Yancowinna" "Etc/GMT" "Etc/GMT+0" "Etc/GMT+1" "Etc/GMT+10" "Etc/GMT+11" "Etc/GMT+12" "Etc/GMT+2" "Etc/GMT+3" "Etc/GMT+4" "Etc/GMT+5" "Etc/GMT+6" "Etc/GMT+7" "Etc/GMT+8" "Etc/GMT+9" "Etc/GMT-0" "Etc/GMT-1" "Etc/GMT-10" "Etc/GMT-11" "Etc/GMT-12" "Etc/GMT-13" "Etc/GMT-14" "Etc/GMT-2" "Etc/GMT-3" "Etc/GMT-4" "Etc/GMT-5" "Etc/GMT-6" "Etc/GMT-7" "Etc/GMT-8" "Etc/GMT-9" "Etc/GMT0" "Etc/Greenwich" "Etc/UCT" "Etc/UTC" "Etc/Universal" "Etc/Zulu" "Europe/Amsterdam" "Europe/Andorra" "Europe/Astrakhan" "Europe/Athens" "Europe/Belfast" "Europe/Belgrade" "Europe/Berlin" "Europe/Bratislava" "Europe/Brussels" "Europe/Bucharest" "Europe/Budapest" "Europe/Busingen" "Europe/Chisinau" "Europe/Copenhagen" "Europe/Dublin" "Europe/Gibraltar" "Europe/Guernsey" "Europe/Helsinki" "Europe/Isle_of_Man" "Europe/Istanbul" "Europe/Jersey" "Europe/Kaliningrad" "Europe/Kirov" "Europe/Kyiv" "Europe/Lisbon" "Europe/Ljubljana" "Europe/London" "Europe/Luxembourg" "Europe/Madrid" "Europe/Malta" "Europe/Mariehamn" "Europe/Minsk" "Europe/Monaco" "Europe/Moscow" "Europe/Nicosia" "Europe/Oslo" "Europe/Paris" "Europe/Podgorica" "Europe/Prague" "Europe/Riga" "Europe/Rome" "Europe/Samara" "Europe/San_Marino" "Europe/Sarajevo" "Europe/Saratov" "Europe/Simferopol" "Europe/Skopje" "Europe/Sofia" "Europe/Stockholm" "Europe/Tallinn" "Europe/Tirane" "Europe/Tiraspol" "Europe/Ulyanovsk" "Europe/Vaduz" "Europe/Vatican" "Europe/Vienna" "Europe/Vilnius" "Europe/Volgograd" "Europe/Warsaw" "Europe/Zagreb" "Europe/Zurich" "Factory" "GMT" "Indian/Antananarivo" "Indian/Chagos" "Indian/Christmas" "Indian/Cocos" "Indian/Comoro" "Indian/Kerguelen" "Indian/Mahe" "Indian/Maldives" "Indian/Mauritius" "Indian/Mayotte" "Indian/Reunion" "Pacific/Apia" "Pacific/Auckland" "Pacific/Bougainville" "Pacific/Chatham" "Pacific/Chuuk" "Pacific/Easter" "Pacific/Efate" "Pacific/Fakaofo" "Pacific/Fiji" "Pacific/Funafuti" "Pacific/Galapagos" "Pacific/Gambier" "Pacific/Guadalcanal" "Pacific/Guam" "Pacific/Honolulu" "Pacific/Johnston" "Pacific/Kanton" "Pacific/Kiritimati" "Pacific/Kosrae" "Pacific/Kwajalein" "Pacific/Majuro" "Pacific/Marquesas" "Pacific/Midway" "Pacific/Nauru" "Pacific/Niue" "Pacific/Norfolk" "Pacific/Noumea" "Pacific/Pago_Pago" "Pacific/Palau" "Pacific/Pitcairn" "Pacific/Pohnpei" "Pacific/Port_Moresby" "Pacific/Rarotonga" "Pacific/Saipan" "Pacific/Samoa" "Pacific/Tahiti" "Pacific/Tarawa" "Pacific/Tongatapu" "Pacific/Wake" "Pacific/Wallis" "Pacific/Yap" "UTC"

Responses

Response samples

200
403
404
422

Content type

application/json

[{"table": {"month": "2025-01",
"average_mood": 2
}
},
{"table": {"month": "2025-02",
"average_mood": 1
}
},
{"table": {"month": "2025-03",
"average_mood": 3
}
}
]

Get circle's daily living activities

Authorizations:

Bearer Token

path Parameters

id

required

integer

query Parameters

adl_type	string Enum: "bathing" "dressing" "eating" "toileting" "transferring" "mobility" "managing_finances" "medication_management" "meal_preparation" "housekeeping" "shopping" "transportation" "communication"
cursor	integer
items_per_page	integer
direction	string

Responses

Response samples

200
401
403
404
422

Content type

application/json

[ ]

Delete circle

Authorizations:

Bearer Token

path Parameters

id

required

integer

Responses

Response samples

200
401
403
404
422

Content type

application/json

{"active_circle_id": null
}

Invite members to existing circle

Authorizations:

Bearer Token

path Parameters

id

required

integer

Request Body schema: application/json

required

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"emails_and_roles": [{"email": "string",
"role": "admin"
}
]
}

Response samples

401
403
404
422

Content type

application/json

{"error": {"code": "unauthorized",
"details": [{"key": "_base",
"message": "Session has expired"
}
]
}
}

Join circle

Authorizations:

Bearer Token

query Parameters

invitation_id

integer

Responses

Response samples

200
401
403
404
422

Content type

application/json

Example

join circle

{"id": 355,
"name": "Kerstin Dibbert",
"invitation_code": "FCCDE5",
"patient_first_name": "Efrain Koch",
"patient_last_name": "Yong Green DC",
"patient_email": "essie_kling@stracke.example",
"patient_birthday": "1963-04-07",
"patient_time_zone": null,
"avatar_url": null,
"placeholder_avatar_data": {"initials": "FF",
"background_color": "#FF0000"
},
"patient_location": null,
"current_user_roles": ["patient"
],
"is_current_user_personal_circle": false,
"current_user_permissions": [{"feature_type": "circle_center_profile",
"permission_type": "edit"
},
{"feature_type": "daily_check_ins",
"permission_type": "edit"
},
{"feature_type": "schedule",
"permission_type": "edit"
},
{"feature_type": "medications",
"permission_type": "edit"
},
{"feature_type": "notes",
"permission_type": "edit"
},
{"feature_type": "activities_of_daily_living",
"permission_type": "edit"
},
{"feature_type": "carereceiver_documentation",
"permission_type": "edit"
},
{"feature_type": "symptoms",
"permission_type": "edit"
},
{"feature_type": "last_wishes",
"permission_type": "edit"
},
{"feature_type": "storage_of_important_documents",
"permission_type": "edit"
},
{"feature_type": "medical_records",
"permission_type": "edit"
},
{"feature_type": "vital_signs",
"permission_type": "edit"
},
{"feature_type": "contacts",
"permission_type": "edit"
},
{"feature_type": "vault_forms",
"permission_type": "edit"
},
{"feature_type": "vault_folders",
"permission_type": "edit"
},
{"feature_type": "vault_documents",
"permission_type": "edit"
},
{"feature_type": "vault_tasks",
"permission_type": "edit"
}
],
"members_count": 3,
"daily_check_ins_enabled": true,
"current_subscription_plan": null,
"free_trial_available": true,
"is_pin_auth_required_for_health": true,
"is_pin_auth_required_for_vault": true,
"current_user_vault_form_permissions": [ ]
}

Get circle's daily living activities

Authorizations:

Bearer Token

path Parameters

id

required

integer

query Parameters

occurrence_time_direction

string

Enum: "asc" "desc"

Responses

Response samples

200
401
403
404
422

Content type

application/json

[ ]

Get circle's last logged vital signs

Authorizations:

Bearer Token

path Parameters

id

required

integer

query Parameters

measurement_time_direction

string

Enum: "asc" "desc"

Responses

Response samples

200
401
403
404
422

Content type

application/json

[ ]

Leave circle

Authorizations:

Bearer Token

path Parameters

id

required

integer

Responses

Response samples

200
401
403
404
422

Content type

application/json

{"active_circle_id": null
}

Get circle's note folders

Authorizations:

Bearer Token

path Parameters

circle_id

required

integer

Responses

Response samples

200
401
403
404
422

Content type

application/json

{"folders": [{"id": 1,
"name": "nulla",
"notes_count": 0
}
],
"all_notes_count": 0
}

Get circle's notes

Authorizations:

Bearer Token

path Parameters

id

required

integer

query Parameters

folder_id	integer Filter notes by folder ID
search_expression	string Search notes by title or content
cursor	integer
items_per_page	integer
direction	string

Responses

Response samples

200
401
403
404
422

Content type

application/json

[ ]

Request to join circle

Authorizations:

Bearer Token

query Parameters

invitation_code

required

string

Responses

Response samples

401
404
422

Content type

application/json

{"error": {"code": "unauthorized",
"details": [{"key": "_base",
"message": "Session has expired"
}
]
}
}

Show circle

Authorizations:

Bearer Token

path Parameters

circle_id

required

integer

Responses

Response samples

200
401
404
422

Content type

application/json

{"id": 403,
"name": "Mose Hodkiewicz",
"invitation_code": "9E08D7",
"patient_first_name": "Lawanna Nikolaus",
"patient_last_name": "Jonas Wisoky",
"patient_email": "derrick.morar@kerluke.example",
"patient_birthday": "2022-02-07",
"patient_time_zone": null,
"avatar_url": null,
"placeholder_avatar_data": {"initials": "JD",
"background_color": "#000000"
},
"patient_location": null,
"current_user_roles": ["caregiver"
],
"is_current_user_personal_circle": false,
"current_user_permissions": [{"feature_type": "circle_center_profile",
"permission_type": "read"
}
],
"members_count": 2,
"daily_check_ins_enabled": true,
"current_subscription_plan": {"id": 199,
"name": "Package 9",
"key": "package_9",
"feature_groups": [{"name": "Health",
"key": "health",
"icon_url": "https://assets.example.com/assets/health-2b31489dbf7e2cf9d8e0507b886708c7362876215038f16de4d1446553b12f86.svg"
},
{"name": "Vault",
"key": "vault",
"icon_url": "https://assets.example.com/assets/vault-0b625efa840333fef7a22e73f38496624a41c4eaa4f73ff199f42082bb7121f4.svg"
}
]
},
"free_trial_available": true,
"is_pin_auth_required_for_health": true,
"is_pin_auth_required_for_vault": true,
"current_user_vault_form_permissions": [ ]
}

Update circle

Authorizations:

Bearer Token

path Parameters

circle_id

required

integer

Request Body schema: multipart/form-data

patient_first_name	string
patient_last_name	string or null
patient_birthday	date
daily_check_ins_enabled	boolean
name	string Name of the circle
avatar	string or null <binary>
	object
is_pin_auth_required_for_health	boolean
is_pin_auth_required_for_vault	boolean

Responses

Response samples

200
401
403
404
422

Content type

application/json

{"id": 409,
"name": "New Circle Name",
"invitation_code": "54320C",
"patient_first_name": "John",
"patient_last_name": "Doe",
"patient_email": "laurie@rice.example",
"patient_birthday": "1990-01-01",
"patient_time_zone": "America/New_York",
"avatar_url": "http://minio:9000/caily-private/private_store/circle/409/example-image20251205-82-a0e910-409.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=minioadmin%2F20251205%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20251205T120701Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=99745588c0daaff2186fcda16ec18f0fb07452cb662c0be303fafc6a8add3e42",
"placeholder_avatar_data": {"background_color": "#000000",
"initials": "JD"
},
"patient_location": {"place_id": "ChIJN1t_tDeuEmsRUsoyG83frY4",
"name": "New York, NY, USA"
},
"current_user_roles": [ ],
"is_current_user_personal_circle": false,
"current_user_permissions": [{"feature_type": "circle_center_profile",
"permission_type": "edit"
}
],
"members_count": 2,
"daily_check_ins_enabled": true,
"current_subscription_plan": null,
"free_trial_available": true,
"is_pin_auth_required_for_health": true,
"is_pin_auth_required_for_vault": true,
"current_user_vault_form_permissions": [ ]
}

Get circle's vault folders

Authorizations:

Bearer Token

path Parameters

circle_id

required

integer

Responses

Response samples

200
401
403
404
422

Content type

application/json

{"folders": [{"id": 1,
"name": null,
"vault_form_id": null,
"vault_form_name": null,
"files_count": 0
}
],
"all_files_count": 0
}

Get circle's vault forms

Authorizations:

Bearer Token

path Parameters

circle_id

required

integer

Responses

Response samples

200
401
403
404
422

Content type

application/json

[{"id": 1,
"name": "abc",
"description": null,
"category_key": "healthcare_records",
"vault_form_response_id": null
},
{"id": 2,
"name": "xyz",
"description": null,
"category_key": "vehicles",
"vault_form_response_id": null
},
{"id": 3,
"name": "def",
"description": null,
"category_key": "vehicles",
"vault_form_response_id": null
}
]

Get circle's vital signs

Authorizations:

Bearer Token

path Parameters

id

required

integer

query Parameters

vital_sign_type	string Enum: "temperature" "heart_rate" "respiratory_rate" "blood_pressure" "oxygen_saturation" "pain_level" "glucose_level" "weight" "height"
time_zone required	string Enum: "Africa/Abidjan" "Africa/Accra" "Africa/Addis_Ababa" "Africa/Algiers" "Africa/Asmara" "Africa/Bamako" "Africa/Bangui" "Africa/Banjul" "Africa/Bissau" "Africa/Blantyre" "Africa/Brazzaville" "Africa/Bujumbura" "Africa/Cairo" "Africa/Casablanca" "Africa/Ceuta" "Africa/Conakry" "Africa/Dakar" "Africa/Dar_es_Salaam" "Africa/Djibouti" "Africa/Douala" "Africa/El_Aaiun" "Africa/Freetown" "Africa/Gaborone" "Africa/Harare" "Africa/Johannesburg" "Africa/Juba" "Africa/Kampala" "Africa/Khartoum" "Africa/Kigali" "Africa/Kinshasa" "Africa/Lagos" "Africa/Libreville" "Africa/Lome" "Africa/Luanda" "Africa/Lubumbashi" "Africa/Lusaka" "Africa/Malabo" "Africa/Maputo" "Africa/Maseru" "Africa/Mbabane" "Africa/Mogadishu" "Africa/Monrovia" "Africa/Nairobi" "Africa/Ndjamena" "Africa/Niamey" "Africa/Nouakchott" "Africa/Ouagadougou" "Africa/Porto-Novo" "Africa/Sao_Tome" "Africa/Timbuktu" "Africa/Tripoli" "Africa/Tunis" "Africa/Windhoek" "America/Adak" "America/Anchorage" "America/Anguilla" "America/Antigua" "America/Araguaina" "America/Argentina/Buenos_Aires" "America/Argentina/Catamarca" "America/Argentina/Cordoba" "America/Argentina/Jujuy" "America/Argentina/La_Rioja" "America/Argentina/Mendoza" "America/Argentina/Rio_Gallegos" "America/Argentina/Salta" "America/Argentina/San_Juan" "America/Argentina/San_Luis" "America/Argentina/Tucuman" "America/Argentina/Ushuaia" "America/Aruba" "America/Asuncion" "America/Atikokan" "America/Atka" "America/Bahia" "America/Bahia_Banderas" "America/Barbados" "America/Belem" "America/Belize" "America/Blanc-Sablon" "America/Boa_Vista" "America/Bogota" "America/Boise" "America/Cambridge_Bay" "America/Campo_Grande" "America/Cancun" "America/Caracas" "America/Cayenne" "America/Cayman" "America/Chicago" "America/Chihuahua" "America/Ciudad_Juarez" "America/Coral_Harbour" "America/Costa_Rica" "America/Creston" "America/Cuiaba" "America/Curacao" "America/Danmarkshavn" "America/Dawson" "America/Dawson_Creek" "America/Denver" "America/Detroit" "America/Dominica" "America/Edmonton" "America/Eirunepe" "America/El_Salvador" "America/Ensenada" "America/Fort_Nelson" "America/Fortaleza" "America/Glace_Bay" "America/Goose_Bay" "America/Grand_Turk" "America/Grenada" "America/Guadeloupe" "America/Guatemala" "America/Guayaquil" "America/Guyana" "America/Halifax" "America/Havana" "America/Hermosillo" "America/Indiana/Indianapolis" "America/Indiana/Knox" "America/Indiana/Marengo" "America/Indiana/Petersburg" "America/Indiana/Tell_City" "America/Indiana/Vevay" "America/Indiana/Vincennes" "America/Indiana/Winamac" "America/Inuvik" "America/Iqaluit" "America/Jamaica" "America/Juneau" "America/Kentucky/Louisville" "America/Kentucky/Monticello" "America/Kralendijk" "America/La_Paz" "America/Lima" "America/Los_Angeles" "America/Lower_Princes" "America/Maceio" "America/Managua" "America/Manaus" "America/Marigot" "America/Martinique" "America/Matamoros" "America/Mazatlan" "America/Menominee" "America/Merida" "America/Metlakatla" "America/Mexico_City" "America/Miquelon" "America/Moncton" "America/Monterrey" "America/Montevideo" "America/Montreal" "America/Montserrat" "America/Nassau" "America/New_York" "America/Nipigon" "America/Nome" "America/Noronha" "America/North_Dakota/Beulah" "America/North_Dakota/Center" "America/North_Dakota/New_Salem" "America/Nuuk" "America/Ojinaga" "America/Panama" "America/Pangnirtung" "America/Paramaribo" "America/Phoenix" "America/Port-au-Prince" "America/Port_of_Spain" "America/Porto_Acre" "America/Porto_Velho" "America/Puerto_Rico" "America/Punta_Arenas" "America/Rainy_River" "America/Rankin_Inlet" "America/Recife" "America/Regina" "America/Resolute" "America/Rio_Branco" "America/Santa_Isabel" "America/Santarem" "America/Santiago" "America/Santo_Domingo" "America/Sao_Paulo" "America/Scoresbysund" "America/Shiprock" "America/Sitka" "America/St_Barthelemy" "America/St_Johns" "America/St_Kitts" "America/St_Lucia" "America/St_Thomas" "America/St_Vincent" "America/Swift_Current" "America/Tegucigalpa" "America/Thule" "America/Thunder_Bay" "America/Tijuana" "America/Toronto" "America/Tortola" "America/Vancouver" "America/Virgin" "America/Whitehorse" "America/Winnipeg" "America/Yakutat" "America/Yellowknife" "Antarctica/Casey" "Antarctica/Davis" "Antarctica/DumontDUrville" "Antarctica/Macquarie" "Antarctica/Mawson" "Antarctica/McMurdo" "Antarctica/Palmer" "Antarctica/Rothera" "Antarctica/Syowa" "Antarctica/Troll" "Antarctica/Vostok" "Arctic/Longyearbyen" "Asia/Aden" "Asia/Almaty" "Asia/Amman" "Asia/Anadyr" "Asia/Aqtau" "Asia/Aqtobe" "Asia/Ashgabat" "Asia/Atyrau" "Asia/Baghdad" "Asia/Bahrain" "Asia/Baku" "Asia/Bangkok" "Asia/Barnaul" "Asia/Beirut" "Asia/Bishkek" "Asia/Brunei" "Asia/Chita" "Asia/Chongqing" "Asia/Colombo" "Asia/Damascus" "Asia/Dhaka" "Asia/Dili" "Asia/Dubai" "Asia/Dushanbe" "Asia/Famagusta" "Asia/Gaza" "Asia/Harbin" "Asia/Hebron" "Asia/Ho_Chi_Minh" "Asia/Hong_Kong" "Asia/Hovd" "Asia/Irkutsk" "Asia/Istanbul" "Asia/Jakarta" "Asia/Jayapura" "Asia/Jerusalem" "Asia/Kabul" "Asia/Kamchatka" "Asia/Karachi" "Asia/Kashgar" "Asia/Kathmandu" "Asia/Khandyga" "Asia/Kolkata" "Asia/Krasnoyarsk" "Asia/Kuala_Lumpur" "Asia/Kuching" "Asia/Kuwait" "Asia/Macau" "Asia/Magadan" "Asia/Makassar" "Asia/Manila" "Asia/Muscat" "Asia/Nicosia" "Asia/Novokuznetsk" "Asia/Novosibirsk" "Asia/Omsk" "Asia/Oral" "Asia/Phnom_Penh" "Asia/Pontianak" "Asia/Pyongyang" "Asia/Qatar" "Asia/Qostanay" "Asia/Qyzylorda" "Asia/Riyadh" "Asia/Sakhalin" "Asia/Samarkand" "Asia/Seoul" "Asia/Shanghai" "Asia/Singapore" "Asia/Srednekolymsk" "Asia/Taipei" "Asia/Tashkent" "Asia/Tbilisi" "Asia/Tehran" "Asia/Tel_Aviv" "Asia/Thimphu" "Asia/Tokyo" "Asia/Tomsk" "Asia/Ulaanbaatar" "Asia/Urumqi" "Asia/Ust-Nera" "Asia/Vientiane" "Asia/Vladivostok" "Asia/Yakutsk" "Asia/Yangon" "Asia/Yekaterinburg" "Asia/Yerevan" "Atlantic/Azores" "Atlantic/Bermuda" "Atlantic/Canary" "Atlantic/Cape_Verde" "Atlantic/Faroe" "Atlantic/Jan_Mayen" "Atlantic/Madeira" "Atlantic/Reykjavik" "Atlantic/South_Georgia" "Atlantic/St_Helena" "Atlantic/Stanley" "Australia/Adelaide" "Australia/Brisbane" "Australia/Broken_Hill" "Australia/Canberra" "Australia/Currie" "Australia/Darwin" "Australia/Eucla" "Australia/Hobart" "Australia/Lindeman" "Australia/Lord_Howe" "Australia/Melbourne" "Australia/Perth" "Australia/Sydney" "Australia/Yancowinna" "Etc/GMT" "Etc/GMT+0" "Etc/GMT+1" "Etc/GMT+10" "Etc/GMT+11" "Etc/GMT+12" "Etc/GMT+2" "Etc/GMT+3" "Etc/GMT+4" "Etc/GMT+5" "Etc/GMT+6" "Etc/GMT+7" "Etc/GMT+8" "Etc/GMT+9" "Etc/GMT-0" "Etc/GMT-1" "Etc/GMT-10" "Etc/GMT-11" "Etc/GMT-12" "Etc/GMT-13" "Etc/GMT-14" "Etc/GMT-2" "Etc/GMT-3" "Etc/GMT-4" "Etc/GMT-5" "Etc/GMT-6" "Etc/GMT-7" "Etc/GMT-8" "Etc/GMT-9" "Etc/GMT0" "Etc/Greenwich" "Etc/UCT" "Etc/UTC" "Etc/Universal" "Etc/Zulu" "Europe/Amsterdam" "Europe/Andorra" "Europe/Astrakhan" "Europe/Athens" "Europe/Belfast" "Europe/Belgrade" "Europe/Berlin" "Europe/Bratislava" "Europe/Brussels" "Europe/Bucharest" "Europe/Budapest" "Europe/Busingen" "Europe/Chisinau" "Europe/Copenhagen" "Europe/Dublin" "Europe/Gibraltar" "Europe/Guernsey" "Europe/Helsinki" "Europe/Isle_of_Man" "Europe/Istanbul" "Europe/Jersey" "Europe/Kaliningrad" "Europe/Kirov" "Europe/Kyiv" "Europe/Lisbon" "Europe/Ljubljana" "Europe/London" "Europe/Luxembourg" "Europe/Madrid" "Europe/Malta" "Europe/Mariehamn" "Europe/Minsk" "Europe/Monaco" "Europe/Moscow" "Europe/Nicosia" "Europe/Oslo" "Europe/Paris" "Europe/Podgorica" "Europe/Prague" "Europe/Riga" "Europe/Rome" "Europe/Samara" "Europe/San_Marino" "Europe/Sarajevo" "Europe/Saratov" "Europe/Simferopol" "Europe/Skopje" "Europe/Sofia" "Europe/Stockholm" "Europe/Tallinn" "Europe/Tirane" "Europe/Tiraspol" "Europe/Ulyanovsk" "Europe/Vaduz" "Europe/Vatican" "Europe/Vienna" "Europe/Vilnius" "Europe/Volgograd" "Europe/Warsaw" "Europe/Zagreb" "Europe/Zurich" "Factory" "GMT" "Indian/Antananarivo" "Indian/Chagos" "Indian/Christmas" "Indian/Cocos" "Indian/Comoro" "Indian/Kerguelen" "Indian/Mahe" "Indian/Maldives" "Indian/Mauritius" "Indian/Mayotte" "Indian/Reunion" "Pacific/Apia" "Pacific/Auckland" "Pacific/Bougainville" "Pacific/Chatham" "Pacific/Chuuk" "Pacific/Easter" "Pacific/Efate" "Pacific/Fakaofo" "Pacific/Fiji" "Pacific/Funafuti" "Pacific/Galapagos" "Pacific/Gambier" "Pacific/Guadalcanal" "Pacific/Guam" "Pacific/Honolulu" "Pacific/Johnston" "Pacific/Kanton" "Pacific/Kiritimati" "Pacific/Kosrae" "Pacific/Kwajalein" "Pacific/Majuro" "Pacific/Marquesas" "Pacific/Midway" "Pacific/Nauru" "Pacific/Niue" "Pacific/Norfolk" "Pacific/Noumea" "Pacific/Pago_Pago" "Pacific/Palau" "Pacific/Pitcairn" "Pacific/Pohnpei" "Pacific/Port_Moresby" "Pacific/Rarotonga" "Pacific/Saipan" "Pacific/Samoa" "Pacific/Tahiti" "Pacific/Tarawa" "Pacific/Tongatapu" "Pacific/Wake" "Pacific/Wallis" "Pacific/Yap" "UTC"
weekly	boolean
cursor	integer
items_per_page	integer
direction	string

Responses

Response samples

200
401
403
404
422

Content type

application/json

[ ]

Get circle's vital signs summary

Authorizations:

Bearer Token

path Parameters

id

required

integer

query Parameters

vital_sign_type

string

Enum: "temperature" "heart_rate" "respiratory_rate" "blood_pressure" "oxygen_saturation" "pain_level" "glucose_level" "weight" "height"

time_zone

required

string

Enum: "Africa/Abidjan" "Africa/Accra" "Africa/Addis_Ababa" "Africa/Algiers" "Africa/Asmara" "Africa/Bamako" "Africa/Bangui" "Africa/Banjul" "Africa/Bissau" "Africa/Blantyre" "Africa/Brazzaville" "Africa/Bujumbura" "Africa/Cairo" "Africa/Casablanca" "Africa/Ceuta" "Africa/Conakry" "Africa/Dakar" "Africa/Dar_es_Salaam" "Africa/Djibouti" "Africa/Douala" "Africa/El_Aaiun" "Africa/Freetown" "Africa/Gaborone" "Africa/Harare" "Africa/Johannesburg" "Africa/Juba" "Africa/Kampala" "Africa/Khartoum" "Africa/Kigali" "Africa/Kinshasa" "Africa/Lagos" "Africa/Libreville" "Africa/Lome" "Africa/Luanda" "Africa/Lubumbashi" "Africa/Lusaka" "Africa/Malabo" "Africa/Maputo" "Africa/Maseru" "Africa/Mbabane" "Africa/Mogadishu" "Africa/Monrovia" "Africa/Nairobi" "Africa/Ndjamena" "Africa/Niamey" "Africa/Nouakchott" "Africa/Ouagadougou" "Africa/Porto-Novo" "Africa/Sao_Tome" "Africa/Timbuktu" "Africa/Tripoli" "Africa/Tunis" "Africa/Windhoek" "America/Adak" "America/Anchorage" "America/Anguilla" "America/Antigua" "America/Araguaina" "America/Argentina/Buenos_Aires" "America/Argentina/Catamarca" "America/Argentina/Cordoba" "America/Argentina/Jujuy" "America/Argentina/La_Rioja" "America/Argentina/Mendoza" "America/Argentina/Rio_Gallegos" "America/Argentina/Salta" "America/Argentina/San_Juan" "America/Argentina/San_Luis" "America/Argentina/Tucuman" "America/Argentina/Ushuaia" "America/Aruba" "America/Asuncion" "America/Atikokan" "America/Atka" "America/Bahia" "America/Bahia_Banderas" "America/Barbados" "America/Belem" "America/Belize" "America/Blanc-Sablon" "America/Boa_Vista" "America/Bogota" "America/Boise" "America/Cambridge_Bay" "America/Campo_Grande" "America/Cancun" "America/Caracas" "America/Cayenne" "America/Cayman" "America/Chicago" "America/Chihuahua" "America/Ciudad_Juarez" "America/Coral_Harbour" "America/Costa_Rica" "America/Creston" "America/Cuiaba" "America/Curacao" "America/Danmarkshavn" "America/Dawson" "America/Dawson_Creek" "America/Denver" "America/Detroit" "America/Dominica" "America/Edmonton" "America/Eirunepe" "America/El_Salvador" "America/Ensenada" "America/Fort_Nelson" "America/Fortaleza" "America/Glace_Bay" "America/Goose_Bay" "America/Grand_Turk" "America/Grenada" "America/Guadeloupe" "America/Guatemala" "America/Guayaquil" "America/Guyana" "America/Halifax" "America/Havana" "America/Hermosillo" "America/Indiana/Indianapolis" "America/Indiana/Knox" "America/Indiana/Marengo" "America/Indiana/Petersburg" "America/Indiana/Tell_City" "America/Indiana/Vevay" "America/Indiana/Vincennes" "America/Indiana/Winamac" "America/Inuvik" "America/Iqaluit" "America/Jamaica" "America/Juneau" "America/Kentucky/Louisville" "America/Kentucky/Monticello" "America/Kralendijk" "America/La_Paz" "America/Lima" "America/Los_Angeles" "America/Lower_Princes" "America/Maceio" "America/Managua" "America/Manaus" "America/Marigot" "America/Martinique" "America/Matamoros" "America/Mazatlan" "America/Menominee" "America/Merida" "America/Metlakatla" "America/Mexico_City" "America/Miquelon" "America/Moncton" "America/Monterrey" "America/Montevideo" "America/Montreal" "America/Montserrat" "America/Nassau" "America/New_York" "America/Nipigon" "America/Nome" "America/Noronha" "America/North_Dakota/Beulah" "America/North_Dakota/Center" "America/North_Dakota/New_Salem" "America/Nuuk" "America/Ojinaga" "America/Panama" "America/Pangnirtung" "America/Paramaribo" "America/Phoenix" "America/Port-au-Prince" "America/Port_of_Spain" "America/Porto_Acre" "America/Porto_Velho" "America/Puerto_Rico" "America/Punta_Arenas" "America/Rainy_River" "America/Rankin_Inlet" "America/Recife" "America/Regina" "America/Resolute" "America/Rio_Branco" "America/Santa_Isabel" "America/Santarem" "America/Santiago" "America/Santo_Domingo" "America/Sao_Paulo" "America/Scoresbysund" "America/Shiprock" "America/Sitka" "America/St_Barthelemy" "America/St_Johns" "America/St_Kitts" "America/St_Lucia" "America/St_Thomas" "America/St_Vincent" "America/Swift_Current" "America/Tegucigalpa" "America/Thule" "America/Thunder_Bay" "America/Tijuana" "America/Toronto" "America/Tortola" "America/Vancouver" "America/Virgin" "America/Whitehorse" "America/Winnipeg" "America/Yakutat" "America/Yellowknife" "Antarctica/Casey" "Antarctica/Davis" "Antarctica/DumontDUrville" "Antarctica/Macquarie" "Antarctica/Mawson" "Antarctica/McMurdo" "Antarctica/Palmer" "Antarctica/Rothera" "Antarctica/Syowa" "Antarctica/Troll" "Antarctica/Vostok" "Arctic/Longyearbyen" "Asia/Aden" "Asia/Almaty" "Asia/Amman" "Asia/Anadyr" "Asia/Aqtau" "Asia/Aqtobe" "Asia/Ashgabat" "Asia/Atyrau" "Asia/Baghdad" "Asia/Bahrain" "Asia/Baku" "Asia/Bangkok" "Asia/Barnaul" "Asia/Beirut" "Asia/Bishkek" "Asia/Brunei" "Asia/Chita" "Asia/Chongqing" "Asia/Colombo" "Asia/Damascus" "Asia/Dhaka" "Asia/Dili" "Asia/Dubai" "Asia/Dushanbe" "Asia/Famagusta" "Asia/Gaza" "Asia/Harbin" "Asia/Hebron" "Asia/Ho_Chi_Minh" "Asia/Hong_Kong" "Asia/Hovd" "Asia/Irkutsk" "Asia/Istanbul" "Asia/Jakarta" "Asia/Jayapura" "Asia/Jerusalem" "Asia/Kabul" "Asia/Kamchatka" "Asia/Karachi" "Asia/Kashgar" "Asia/Kathmandu" "Asia/Khandyga" "Asia/Kolkata" "Asia/Krasnoyarsk" "Asia/Kuala_Lumpur" "Asia/Kuching" "Asia/Kuwait" "Asia/Macau" "Asia/Magadan" "Asia/Makassar" "Asia/Manila" "Asia/Muscat" "Asia/Nicosia" "Asia/Novokuznetsk" "Asia/Novosibirsk" "Asia/Omsk" "Asia/Oral" "Asia/Phnom_Penh" "Asia/Pontianak" "Asia/Pyongyang" "Asia/Qatar" "Asia/Qostanay" "Asia/Qyzylorda" "Asia/Riyadh" "Asia/Sakhalin" "Asia/Samarkand" "Asia/Seoul" "Asia/Shanghai" "Asia/Singapore" "Asia/Srednekolymsk" "Asia/Taipei" "Asia/Tashkent" "Asia/Tbilisi" "Asia/Tehran" "Asia/Tel_Aviv" "Asia/Thimphu" "Asia/Tokyo" "Asia/Tomsk" "Asia/Ulaanbaatar" "Asia/Urumqi" "Asia/Ust-Nera" "Asia/Vientiane" "Asia/Vladivostok" "Asia/Yakutsk" "Asia/Yangon" "Asia/Yekaterinburg" "Asia/Yerevan" "Atlantic/Azores" "Atlantic/Bermuda" "Atlantic/Canary" "Atlantic/Cape_Verde" "Atlantic/Faroe" "Atlantic/Jan_Mayen" "Atlantic/Madeira" "Atlantic/Reykjavik" "Atlantic/South_Georgia" "Atlantic/St_Helena" "Atlantic/Stanley" "Australia/Adelaide" "Australia/Brisbane" "Australia/Broken_Hill" "Australia/Canberra" "Australia/Currie" "Australia/Darwin" "Australia/Eucla" "Australia/Hobart" "Australia/Lindeman" "Australia/Lord_Howe" "Australia/Melbourne" "Australia/Perth" "Australia/Sydney" "Australia/Yancowinna" "Etc/GMT" "Etc/GMT+0" "Etc/GMT+1" "Etc/GMT+10" "Etc/GMT+11" "Etc/GMT+12" "Etc/GMT+2" "Etc/GMT+3" "Etc/GMT+4" "Etc/GMT+5" "Etc/GMT+6" "Etc/GMT+7" "Etc/GMT+8" "Etc/GMT+9" "Etc/GMT-0" "Etc/GMT-1" "Etc/GMT-10" "Etc/GMT-11" "Etc/GMT-12" "Etc/GMT-13" "Etc/GMT-14" "Etc/GMT-2" "Etc/GMT-3" "Etc/GMT-4" "Etc/GMT-5" "Etc/GMT-6" "Etc/GMT-7" "Etc/GMT-8" "Etc/GMT-9" "Etc/GMT0" "Etc/Greenwich" "Etc/UCT" "Etc/UTC" "Etc/Universal" "Etc/Zulu" "Europe/Amsterdam" "Europe/Andorra" "Europe/Astrakhan" "Europe/Athens" "Europe/Belfast" "Europe/Belgrade" "Europe/Berlin" "Europe/Bratislava" "Europe/Brussels" "Europe/Bucharest" "Europe/Budapest" "Europe/Busingen" "Europe/Chisinau" "Europe/Copenhagen" "Europe/Dublin" "Europe/Gibraltar" "Europe/Guernsey" "Europe/Helsinki" "Europe/Isle_of_Man" "Europe/Istanbul" "Europe/Jersey" "Europe/Kaliningrad" "Europe/Kirov" "Europe/Kyiv" "Europe/Lisbon" "Europe/Ljubljana" "Europe/London" "Europe/Luxembourg" "Europe/Madrid" "Europe/Malta" "Europe/Mariehamn" "Europe/Minsk" "Europe/Monaco" "Europe/Moscow" "Europe/Nicosia" "Europe/Oslo" "Europe/Paris" "Europe/Podgorica" "Europe/Prague" "Europe/Riga" "Europe/Rome" "Europe/Samara" "Europe/San_Marino" "Europe/Sarajevo" "Europe/Saratov" "Europe/Simferopol" "Europe/Skopje" "Europe/Sofia" "Europe/Stockholm" "Europe/Tallinn" "Europe/Tirane" "Europe/Tiraspol" "Europe/Ulyanovsk" "Europe/Vaduz" "Europe/Vatican" "Europe/Vienna" "Europe/Vilnius" "Europe/Volgograd" "Europe/Warsaw" "Europe/Zagreb" "Europe/Zurich" "Factory" "GMT" "Indian/Antananarivo" "Indian/Chagos" "Indian/Christmas" "Indian/Cocos" "Indian/Comoro" "Indian/Kerguelen" "Indian/Mahe" "Indian/Maldives" "Indian/Mauritius" "Indian/Mayotte" "Indian/Reunion" "Pacific/Apia" "Pacific/Auckland" "Pacific/Bougainville" "Pacific/Chatham" "Pacific/Chuuk" "Pacific/Easter" "Pacific/Efate" "Pacific/Fakaofo" "Pacific/Fiji" "Pacific/Funafuti" "Pacific/Galapagos" "Pacific/Gambier" "Pacific/Guadalcanal" "Pacific/Guam" "Pacific/Honolulu" "Pacific/Johnston" "Pacific/Kanton" "Pacific/Kiritimati" "Pacific/Kosrae" "Pacific/Kwajalein" "Pacific/Majuro" "Pacific/Marquesas" "Pacific/Midway" "Pacific/Nauru" "Pacific/Niue" "Pacific/Norfolk" "Pacific/Noumea" "Pacific/Pago_Pago" "Pacific/Palau" "Pacific/Pitcairn" "Pacific/Pohnpei" "Pacific/Port_Moresby" "Pacific/Rarotonga" "Pacific/Saipan" "Pacific/Samoa" "Pacific/Tahiti" "Pacific/Tarawa" "Pacific/Tongatapu" "Pacific/Wake" "Pacific/Wallis" "Pacific/Yap" "UTC"

Responses

Response samples

200
401
403
404
422

Content type

application/json

{"months": [ ],
"average_annual_imperial_value": null,
"average_annual_metric_value": null,
"average_annual_measurement_2_value": null,
"average_weekly_imperial_value": null,
"average_weekly_metric_value": null,
"average_weekly_measurement_2_value": null
}

[COMMON] Note Folders

Create note folders

Authorizations:

Bearer Token

path Parameters

circle_id

required

integer

Request Body schema: application/json
required

name

string

Responses

Request samples

Payload

Content type

application/json

{"name": "string"
}

Response samples

201
401
403
404
422

Content type

application/json

{"id": 28,
"name": "Medical",
"created_at": "2025-12-05T12:07:18.217689Z",
"updated_at": "2025-12-05T12:07:18.217689Z"
}

Destroy note folders

Authorizations:

Bearer Token

path Parameters

id

required

integer

Note Folder ID

Responses

Response samples

401
403
404
422

Content type

application/json

{"error": {"code": "unauthorized",
"details": [{"key": "_base",
"message": "Session has expired"
}
]
}
}

Update note folders

Authorizations:

Bearer Token

path Parameters

id

required

integer

Note Folder ID

Request Body schema: application/json
required

name

string

Responses

Request samples

Payload

Content type

application/json

{"name": "string"
}

Response samples

200
401
403
404
422

Content type

application/json

{"id": 35,
"name": "New Name",
"created_at": "2025-12-05T12:07:19.080544Z",
"updated_at": "2025-12-05T12:07:19.125785Z"
}

[COMMON] Vault Folders

Create vault folders

Authorizations:

Bearer Token

path Parameters

circle_id

required

integer

Request Body schema: application/json
required

name

string

Responses

Request samples

Payload

Content type

application/json

{"name": "string"
}

Response samples

201
401
403
404
422

Content type

application/json

{"id": 19,
"name": "Personal",
"vault_form_name": null,
"created_at": "2025-12-05T12:07:35.310193Z",
"updated_at": "2025-12-05T12:07:35.310193Z"
}

Destroy vault folders

Authorizations:

Bearer Token

path Parameters

id

required

integer

Vault Folder ID

Responses

Response samples

401
403
404
422

Content type

application/json

{"error": {"code": "unauthorized",
"details": [{"key": "_base",
"message": "Session has expired"
}
]
}
}

Get single vault folder

Authorizations:

Bearer Token

path Parameters

id

required

integer

Vault Folder ID

Responses

Response samples

200
401
403
404
422

Content type

application/json

{"id": 26,
"name": null,
"vault_form_name": null,
"created_at": "2025-12-05T12:07:35.781712Z",
"updated_at": "2025-12-05T12:07:35.781712Z"
}

Update vault folders

Authorizations:

Bearer Token

path Parameters

id

required

integer

Vault Folder ID

Request Body schema: application/json
required

name

string

Responses

Request samples

Payload

Content type

application/json

{"name": "string"
}

Response samples

200
401
403
404
422

Content type

application/json

{"id": 32,
"name": "New Name",
"vault_form_name": null,
"created_at": "2025-12-05T12:07:35.975752Z",
"updated_at": "2025-12-05T12:07:36.011780Z"
}

[COMMON] Connected Care Facilities

Create connected care facility

Authorizations:

Bearer Token

path Parameters

circle_id

required

integer

query Parameters

auth_code required	string
state required	string

Responses

Response samples

401
403
404
422

Content type

application/json

{"error": {"code": "unauthorized",
"details": [{"key": "_base",
"message": "Session has expired"
}
]
}
}

Delete connected care facility

Authorizations:

Bearer Token

path Parameters

circle_id required	integer
id required	integer

Responses

Response samples

401
403
404
422

Content type

application/json

{"error": {"code": "unauthorized",
"details": [{"key": "_base",
"message": "Session has expired"
}
]
}
}

[COMMON] Consents

List consents

Responses

Response samples

200

Content type

application/json

[{"id": 4,
"consent_type": "terms_and_conditions",
"document_url": "http://minio:9000/caily-private/private_store/fb48394bfa912b2e40e757865ec5b452?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=minioadmin%2F20251205%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20251205T120704Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=29c61f902036ab0c30597e6c89f6843466a428251e66df7a64b483f50fbbd7f6",
"version": 1
},
{"id": 3,
"consent_type": "privacy_policy",
"document_url": "http://minio:9000/caily-private/private_store/fb48394bfa912b2e40e757865ec5b452?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=minioadmin%2F20251205%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20251205T120704Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=29c61f902036ab0c30597e6c89f6843466a428251e66df7a64b483f50fbbd7f6",
"version": 1
}
]

[COMMON] Contacts

Create contact

Authorizations:

Bearer Token

path Parameters

circle_id

required

integer

Request Body schema: application/json

name	string
email	string Email or phone number is required
phone_number	string
notes	string
category	string or null Enum: "family" "doctors" "lawyers" "other" "friends" "work" "financial" "emergency"

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"email": "string",
"phone_number": "string",
"notes": "string",
"category": "family"
}

Response samples

201
401
403
404
422

Content type

application/json

{"id": 19,
"name": "John Doe",
"email": "john.doe@example.com",
"phone_number": {"code": "+48",
"number": "12 345 67 89"
},
"notes": "Test contact",
"category": "family"
}

Update contact

Authorizations:

Bearer Token

path Parameters

id

required

integer

Responses

Response samples

401
403
404
422

Content type

application/json

{"error": {"code": "unauthorized",
"details": [{"key": "_base",
"message": "Session has expired"
}
]
}
}

Update contact

Authorizations:

Bearer Token

path Parameters

id

required

integer

Request Body schema: application/json

name	string
email	string
phone_number	string
notes	string
category	string or null Enum: "family" "doctors" "lawyers" "other" "friends" "work" "financial" "emergency"

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"email": "string",
"phone_number": "string",
"notes": "string",
"category": "family"
}

Response samples

200
401
403
404
422

Content type

application/json

{"id": 26,
"name": "John Doe",
"email": "john.doe@example.com",
"phone_number": {"code": "+48",
"number": "12 345 67 89"
},
"notes": "Test contact",
"category": "family"
}

[COMMON] Daily Check Ins

Create daily check ins

Authorizations:

Bearer Token

path Parameters

circle_id

required

integer

Request Body schema: application/json
required

mood	string Enum: "amazing" "good" "alright" "not_ok" "awful"
note	string
date	date

Responses

Request samples

Payload

Content type

application/json

{"mood": "amazing",
"note": "string",
"date": null
}

Response samples

201
403
404
422

Content type

application/json

{"id": 42,
"mood": "good",
"note": "I'm feeling great today!",
"date": "2025-12-05"
}

Update daily check in

Authorizations:

Bearer Token

path Parameters

id required	integer
circle_id required	integer

Request Body schema: application/json

mood	string Enum: "amazing" "good" "alright" "not_ok" "awful"
note	string
date	date

Responses

Request samples

Payload

Content type

application/json

{"mood": "amazing",
"note": "string",
"date": null
}

Response samples

200
403
404
422

Content type

application/json

{"id": 44,
"mood": "good",
"note": "I'm feeling great today!",
"date": "2025-12-04"
}

[COMMON] Daily Living Activities

Create daily living activity

Authorizations:

Bearer Token

path Parameters

circle_id

required

integer

Request Body schema: application/json
required

occurrence_time	string <date_time>
independence_level	string Enum: "independent" "supervision" "partial_assistance" "total_assistance"
adl_type	string Enum: "bathing" "dressing" "eating" "toileting" "transferring" "mobility" "managing_finances" "medication_management" "meal_preparation" "housekeeping" "shopping" "transportation" "communication"
calendar_entry_id	integer or null ADL habit calendar entry id, when passed calendar entry is marked as completed

Responses

Request samples

Payload

Content type

application/json

{"occurrence_time": "string",
"independence_level": "independent",
"adl_type": "bathing",
"calendar_entry_id": 0
}

Response samples

201
401
403
404
422

Content type

application/json

{"id": 1,
"occurrence_time": "2025-12-05T12:07:07.000000Z",
"independence_level": "independent"
}

Delete daily living activity

Authorizations:

Bearer Token

path Parameters

id

required

integer

Responses

Response samples

401
403
404
422

Content type

application/json

{"error": {"code": "unauthorized",
"details": [{"key": "_base",
"message": "Session has expired"
}
]
}
}

Show daily living activity

Authorizations:

Bearer Token

path Parameters

id

required

integer

Responses

Response samples

200
401
403
404
422

Content type

application/json

{"id": 10,
"occurrence_time": "2025-12-06T06:28:01.546549Z",
"independence_level": "partial_assistance"
}

Update daily living activity

Authorizations:

Bearer Token

path Parameters

id

required

integer

Request Body schema: application/json

occurrence_time	string <date_time>
independence_level	string Enum: "independent" "supervision" "partial_assistance" "total_assistance"

Responses

Request samples

Payload

Content type

application/json

{"occurrence_time": "string",
"independence_level": "independent"
}

Response samples

200
401
403
404
422

Content type

application/json

{"id": 16,
"occurrence_time": "2025-12-05T12:07:08.000000Z",
"independence_level": "independent"
}

[COMMON] Devices

Create device

Authorizations:

Bearer Token

Request Body schema: application/json
required

token

string

Responses

Request samples

Payload

Content type

application/json

{"token": "1869591726251dd4f0e20cafda382626"
}

Response samples

401
422

Content type

application/json

{"error": {"code": "unauthorized",
"details": [{"key": "_base",
"message": "Session has expired"
}
]
}
}

[COMMON] Documentation categories

List basic documentation categories

Responses

Response samples

200

Content type

application/json

[{"id": 1,
"name": "in",
"hint": null
},
{"id": 2,
"name": "est",
"hint": null
},
{"id": 3,
"name": "quia",
"hint": null
}
]

[COMMON] Feature Flags

Show feature flag

Authorizations:

Bearer Token

path Parameters

feature_flag_name

required

string

Feature Flag Name

Responses

Response samples

200
401
404

Content type

application/json

{"name": "test_feature_flag_1",
"flag_type": "boolean",
"value": "true",
"allowed_values": ["true",
"false"
]
}

[COMMON] Feature Permissions

Feature Permissions

Authorizations:

Bearer Token

path Parameters

circle_id

required

integer

query Parameters

feature_type

string

Enum	Description
circle_center_profile	0
daily_check_ins	1
schedule	2
medications	4
notes	5
activities_of_daily_living	6
carereceiver_documentation	7
symptoms	8
last_wishes	9
storage_of_important_documents	10
medical_records	11
vital_signs	12
contacts	13
vault_forms	14
vault_folders	15
vault_documents	16
vault_tasks	17

resourcable_type

string

Enum: "VaultFolder" "VaultForm" "Note"

resourcable_id

integer

Responses

Response samples

200
401
403
404
422

Content type

application/json

Example

Get circle's feature permissions

[ ]

Update feature permissions

Authorizations:

Bearer Token

path Parameters

circle_id

required

integer

Request Body schema: application/json
required

feature_type	string
	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"feature_type": "string",
"permissions": [{"user_id": 0,
"permission_type": "string"
}
]
}

Response samples

200
401
403
404
422

Content type

application/json

[{"id": 360,
"feature_type": "medications",
"permission_type": "edit",
"user_id": 984,
"user_email": "user984@example.com",
"user_first_name": "Miss Wilda Heaney",
"user_last_name": "Luke Blick",
"user_avatar_url": null,
"user_placeholder_avatar_data": {"initials": "FF",
"background_color": "#FF0000"
},
"user_roles": ["patient"
],
"resourcable_type": null,
"resourcable_id": null
}
]

[COMMON] Filters

List filters

Authorizations:

Bearer Token

Responses

Response samples

200
401

Content type

application/json

{"adl_type": [{"label": "Bathing",
"value": "bathing",
"description": "Washing oneself, including grooming and hygiene tasks."
},
{"label": "Dressing",
"value": "dressing",
"description": "Selecting and putting on appropriate clothing."
},
{"label": "Eating",
"value": "eating",
"description": "Feeding oneself (not including meal preparation)."
},
{"label": "Toileting",
"value": "toileting",
"description": "Managing bathroom needs, including continence."
},
{"label": "Transferring",
"value": "transferring",
"description": "Moving in and out of bed or chair."
},
{"label": "Mobility",
"value": "mobility",
"description": "Walking or moving around safely."
},
{"label": "Managing finances",
"value": "managing_finances",
"description": "Handling money, paying bills, and budgeting."
},
{"label": "Medication management",
"value": "medication_management",
"description": "Taking prescribed medications correctly."
},
{"label": "Meal preparation",
"value": "meal_preparation",
"description": "Planning, preparing, and serving meals."
},
{"label": "Housekeeping",
"value": "housekeeping",
"description": "Cleaning and maintaining a living space."
},
{"label": "Shopping",
"value": "shopping",
"description": "Purchasing groceries and other necessities."
},
{"label": "Transportation",
"value": "transportation",
"description": "Using public or private transportation."
},
{"label": "Communication",
"value": "communication",
"description": "Using a phones, computers, or other devices to stay in touch."
}
],
"vital_sign_type": [{"label": "Temperature",
"value": "temperature",
"description": null
},
{"label": "Heart rate",
"value": "heart_rate",
"description": null
},
{"label": "Respiratory rate",
"value": "respiratory_rate",
"description": null
},
{"label": "Blood pressure",
"value": "blood_pressure",
"description": null
},
{"label": "Oxygen saturation",
"value": "oxygen_saturation",
"description": null
},
{"label": "Pain level",
"value": "pain_level",
"description": null
},
{"label": "Glucose level",
"value": "glucose_level",
"description": null
},
{"label": "Weight",
"value": "weight",
"description": null
},
{"label": "Height",
"value": "height",
"description": null
}
],
"vital_sign_measurement_type": [{"label": "Temperature",
"value": "temperature",
"description": null
},
{"label": "Heart rate",
"value": "heart_rate",
"description": null
},
{"label": "Respiratory rate",
"value": "respiratory_rate",
"description": null
},
{"label": "Blood pressure",
"value": "blood_pressure",
"description": null
},
{"label": "Oxygen saturation",
"value": "oxygen_saturation",
"description": null
},
{"label": "Pain level",
"value": "pain_level",
"description": null
},
{"label": "Glucose level",
"value": "glucose_level",
"description": null
},
{"label": "Weight",
"value": "weight",
"description": null
},
{"label": "Height",
"value": "height",
"description": null
}
],
"contact_category": [{"label": "Family",
"value": "family",
"description": null
},
{"label": "Doctors",
"value": "doctors",
"description": null
},
{"label": "Lawyers",
"value": "lawyers",
"description": null
},
{"label": "Other",
"value": "other",
"description": null
},
{"label": "Friends",
"value": "friends",
"description": null
},
{"label": "Work",
"value": "work",
"description": null
},
{"label": "Financial",
"value": "financial",
"description": null
},
{"label": "Emergency",
"value": "emergency",
"description": null
}
],
"notification_category": [ ],
"notification_type": [{"label": "General notification",
"value": "system_notification",
"description": null
},
{"label": "New circle invitation",
"value": "new_circle_invitation",
"description": null
},
{"label": "New circle member",
"value": "new_circle_member",
"description": null
},
{"label": "Join request accept",
"value": "join_request_accept",
"description": null
},
{"label": "Circle member left",
"value": "circle_member_left",
"description": null
},
{"label": "Circle member role change",
"value": "circle_member_role_change",
"description": null
},
{"label": "User removed from circle",
"value": "user_removed_from_circle",
"description": null
},
{"label": "Missed medication",
"value": "missed_medication",
"description": null
},
{"label": "Medication alert",
"value": "medication_alert",
"description": null
},
{"label": "New note",
"value": "new_note",
"description": null
},
{"label": "Note edit",
"value": "note_edit",
"description": null
},
{"label": "New symptom log",
"value": "new_symptom_log",
"description": null
},
{"label": "New daily living activity log",
"value": "new_daily_living_activity_log",
"description": null
},
{"label": "Carereceiver documentation update",
"value": "carereceiver_documentation_edit",
"description": null
},
{"label": "Event alert",
"value": "event_alert",
"description": null
},
{"label": "Task alert",
"value": "task_alert",
"description": null
},
{"label": "Habit alert",
"value": "habit_alert",
"description": null
},
{"label": "Missed habit",
"value": "missed_habit",
"description": null
},
{"label": "Vault update",
"value": "vault_update",
"description": null
},
{"label": "Vault document update",
"value": "vault_document_update",
"description": null
},
{"label": "New vault task",
"value": "new_vault_task",
"description": null
},
{"label": "New message",
"value": "new_message",
"description": null
},
{"label": "New conversation",
"value": "new_conversation",
"description": null
},
{"label": "New vital sign log",
"value": "new_vital_sign_log",
"description": null
},
{"label": "Circle deleted",
"value": "circle_deleted",
"description": null
}
],
"notification_group": [{"label": "General",
"value": "system",
"description": null
},
{"label": "Circle",
"value": "circle",
"description": null
},
{"label": "Health",
"value": "health",
"description": null
},
{"label": "Events",
"value": "events",
"description": null
},
{"label": "Tasks",
"value": "tasks",
"description": null
},
{"label": "Habits",
"value": "habits",
"description": null
},
{"label": "Vault",
"value": "vault",
"description": null
},
{"label": "Chat",
"value": "chat",
"description": null
}
]
}

[COMMON] Habits

Create habit

Authorizations:

Bearer Token

Request Body schema: multipart/form-data

name required	string
notes	string or null
alarm_before_minutes	integer or null Alarm before minutes, max 1440
periodicity_dow required	Array of integers Items Enum: 0 1 2 3 4 5 6
start_date required	date Local start date of the series, max 2 months in the past
start_hour required	string <(?-mix:^(?:[01]\d\|2[0-3]):(?:[0-5]{1}\d{1})$)> Local start hour of the event
time_zone required	string Enum: "Africa/Abidjan" "Africa/Accra" "Africa/Addis_Ababa" "Africa/Algiers" "Africa/Asmara" "Africa/Bamako" "Africa/Bangui" "Africa/Banjul" "Africa/Bissau" "Africa/Blantyre" "Africa/Brazzaville" "Africa/Bujumbura" "Africa/Cairo" "Africa/Casablanca" "Africa/Ceuta" "Africa/Conakry" "Africa/Dakar" "Africa/Dar_es_Salaam" "Africa/Djibouti" "Africa/Douala" "Africa/El_Aaiun" "Africa/Freetown" "Africa/Gaborone" "Africa/Harare" "Africa/Johannesburg" "Africa/Juba" "Africa/Kampala" "Africa/Khartoum" "Africa/Kigali" "Africa/Kinshasa" "Africa/Lagos" "Africa/Libreville" "Africa/Lome" "Africa/Luanda" "Africa/Lubumbashi" "Africa/Lusaka" "Africa/Malabo" "Africa/Maputo" "Africa/Maseru" "Africa/Mbabane" "Africa/Mogadishu" "Africa/Monrovia" "Africa/Nairobi" "Africa/Ndjamena" "Africa/Niamey" "Africa/Nouakchott" "Africa/Ouagadougou" "Africa/Porto-Novo" "Africa/Sao_Tome" "Africa/Timbuktu" "Africa/Tripoli" "Africa/Tunis" "Africa/Windhoek" "America/Adak" "America/Anchorage" "America/Anguilla" "America/Antigua" "America/Araguaina" "America/Argentina/Buenos_Aires" "America/Argentina/Catamarca" "America/Argentina/Cordoba" "America/Argentina/Jujuy" "America/Argentina/La_Rioja" "America/Argentina/Mendoza" "America/Argentina/Rio_Gallegos" "America/Argentina/Salta" "America/Argentina/San_Juan" "America/Argentina/San_Luis" "America/Argentina/Tucuman" "America/Argentina/Ushuaia" "America/Aruba" "America/Asuncion" "America/Atikokan" "America/Atka" "America/Bahia" "America/Bahia_Banderas" "America/Barbados" "America/Belem" "America/Belize" "America/Blanc-Sablon" "America/Boa_Vista" "America/Bogota" "America/Boise" "America/Cambridge_Bay" "America/Campo_Grande" "America/Cancun" "America/Caracas" "America/Cayenne" "America/Cayman" "America/Chicago" "America/Chihuahua" "America/Ciudad_Juarez" "America/Coral_Harbour" "America/Costa_Rica" "America/Creston" "America/Cuiaba" "America/Curacao" "America/Danmarkshavn" "America/Dawson" "America/Dawson_Creek" "America/Denver" "America/Detroit" "America/Dominica" "America/Edmonton" "America/Eirunepe" "America/El_Salvador" "America/Ensenada" "America/Fort_Nelson" "America/Fortaleza" "America/Glace_Bay" "America/Goose_Bay" "America/Grand_Turk" "America/Grenada" "America/Guadeloupe" "America/Guatemala" "America/Guayaquil" "America/Guyana" "America/Halifax" "America/Havana" "America/Hermosillo" "America/Indiana/Indianapolis" "America/Indiana/Knox" "America/Indiana/Marengo" "America/Indiana/Petersburg" "America/Indiana/Tell_City" "America/Indiana/Vevay" "America/Indiana/Vincennes" "America/Indiana/Winamac" "America/Inuvik" "America/Iqaluit" "America/Jamaica" "America/Juneau" "America/Kentucky/Louisville" "America/Kentucky/Monticello" "America/Kralendijk" "America/La_Paz" "America/Lima" "America/Los_Angeles" "America/Lower_Princes" "America/Maceio" "America/Managua" "America/Manaus" "America/Marigot" "America/Martinique" "America/Matamoros" "America/Mazatlan" "America/Menominee" "America/Merida" "America/Metlakatla" "America/Mexico_City" "America/Miquelon" "America/Moncton" "America/Monterrey" "America/Montevideo" "America/Montreal" "America/Montserrat" "America/Nassau" "America/New_York" "America/Nipigon" "America/Nome" "America/Noronha" "America/North_Dakota/Beulah" "America/North_Dakota/Center" "America/North_Dakota/New_Salem" "America/Nuuk" "America/Ojinaga" "America/Panama" "America/Pangnirtung" "America/Paramaribo" "America/Phoenix" "America/Port-au-Prince" "America/Port_of_Spain" "America/Porto_Acre" "America/Porto_Velho" "America/Puerto_Rico" "America/Punta_Arenas" "America/Rainy_River" "America/Rankin_Inlet" "America/Recife" "America/Regina" "America/Resolute" "America/Rio_Branco" "America/Santa_Isabel" "America/Santarem" "America/Santiago" "America/Santo_Domingo" "America/Sao_Paulo" "America/Scoresbysund" "America/Shiprock" "America/Sitka" "America/St_Barthelemy" "America/St_Johns" "America/St_Kitts" "America/St_Lucia" "America/St_Thomas" "America/St_Vincent" "America/Swift_Current" "America/Tegucigalpa" "America/Thule" "America/Thunder_Bay" "America/Tijuana" "America/Toronto" "America/Tortola" "America/Vancouver" "America/Virgin" "America/Whitehorse" "America/Winnipeg" "America/Yakutat" "America/Yellowknife" "Antarctica/Casey" "Antarctica/Davis" "Antarctica/DumontDUrville" "Antarctica/Macquarie" "Antarctica/Mawson" "Antarctica/McMurdo" "Antarctica/Palmer" "Antarctica/Rothera" "Antarctica/Syowa" "Antarctica/Troll" "Antarctica/Vostok" "Arctic/Longyearbyen" "Asia/Aden" "Asia/Almaty" "Asia/Amman" "Asia/Anadyr" "Asia/Aqtau" "Asia/Aqtobe" "Asia/Ashgabat" "Asia/Atyrau" "Asia/Baghdad" "Asia/Bahrain" "Asia/Baku" "Asia/Bangkok" "Asia/Barnaul" "Asia/Beirut" "Asia/Bishkek" "Asia/Brunei" "Asia/Chita" "Asia/Chongqing" "Asia/Colombo" "Asia/Damascus" "Asia/Dhaka" "Asia/Dili" "Asia/Dubai" "Asia/Dushanbe" "Asia/Famagusta" "Asia/Gaza" "Asia/Harbin" "Asia/Hebron" "Asia/Ho_Chi_Minh" "Asia/Hong_Kong" "Asia/Hovd" "Asia/Irkutsk" "Asia/Istanbul" "Asia/Jakarta" "Asia/Jayapura" "Asia/Jerusalem" "Asia/Kabul" "Asia/Kamchatka" "Asia/Karachi" "Asia/Kashgar" "Asia/Kathmandu" "Asia/Khandyga" "Asia/Kolkata" "Asia/Krasnoyarsk" "Asia/Kuala_Lumpur" "Asia/Kuching" "Asia/Kuwait" "Asia/Macau" "Asia/Magadan" "Asia/Makassar" "Asia/Manila" "Asia/Muscat" "Asia/Nicosia" "Asia/Novokuznetsk" "Asia/Novosibirsk" "Asia/Omsk" "Asia/Oral" "Asia/Phnom_Penh" "Asia/Pontianak" "Asia/Pyongyang" "Asia/Qatar" "Asia/Qostanay" "Asia/Qyzylorda" "Asia/Riyadh" "Asia/Sakhalin" "Asia/Samarkand" "Asia/Seoul" "Asia/Shanghai" "Asia/Singapore" "Asia/Srednekolymsk" "Asia/Taipei" "Asia/Tashkent" "Asia/Tbilisi" "Asia/Tehran" "Asia/Tel_Aviv" "Asia/Thimphu" "Asia/Tokyo" "Asia/Tomsk" "Asia/Ulaanbaatar" "Asia/Urumqi" "Asia/Ust-Nera" "Asia/Vientiane" "Asia/Vladivostok" "Asia/Yakutsk" "Asia/Yangon" "Asia/Yekaterinburg" "Asia/Yerevan" "Atlantic/Azores" "Atlantic/Bermuda" "Atlantic/Canary" "Atlantic/Cape_Verde" "Atlantic/Faroe" "Atlantic/Jan_Mayen" "Atlantic/Madeira" "Atlantic/Reykjavik" "Atlantic/South_Georgia" "Atlantic/St_Helena" "Atlantic/Stanley" "Australia/Adelaide" "Australia/Brisbane" "Australia/Broken_Hill" "Australia/Canberra" "Australia/Currie" "Australia/Darwin" "Australia/Eucla" "Australia/Hobart" "Australia/Lindeman" "Australia/Lord_Howe" "Australia/Melbourne" "Australia/Perth" "Australia/Sydney" "Australia/Yancowinna" "Etc/GMT" "Etc/GMT+0" "Etc/GMT+1" "Etc/GMT+10" "Etc/GMT+11" "Etc/GMT+12" "Etc/GMT+2" "Etc/GMT+3" "Etc/GMT+4" "Etc/GMT+5" "Etc/GMT+6" "Etc/GMT+7" "Etc/GMT+8" "Etc/GMT+9" "Etc/GMT-0" "Etc/GMT-1" "Etc/GMT-10" "Etc/GMT-11" "Etc/GMT-12" "Etc/GMT-13" "Etc/GMT-14" "Etc/GMT-2" "Etc/GMT-3" "Etc/GMT-4" "Etc/GMT-5" "Etc/GMT-6" "Etc/GMT-7" "Etc/GMT-8" "Etc/GMT-9" "Etc/GMT0" "Etc/Greenwich" "Etc/UCT" "Etc/UTC" "Etc/Universal" "Etc/Zulu" "Europe/Amsterdam" "Europe/Andorra" "Europe/Astrakhan" "Europe/Athens" "Europe/Belfast" "Europe/Belgrade" "Europe/Berlin" "Europe/Bratislava" "Europe/Brussels" "Europe/Bucharest" "Europe/Budapest" "Europe/Busingen" "Europe/Chisinau" "Europe/Copenhagen" "Europe/Dublin" "Europe/Gibraltar" "Europe/Guernsey" "Europe/Helsinki" "Europe/Isle_of_Man" "Europe/Istanbul" "Europe/Jersey" "Europe/Kaliningrad" "Europe/Kirov" "Europe/Kyiv" "Europe/Lisbon" "Europe/Ljubljana" "Europe/London" "Europe/Luxembourg" "Europe/Madrid" "Europe/Malta" "Europe/Mariehamn" "Europe/Minsk" "Europe/Monaco" "Europe/Moscow" "Europe/Nicosia" "Europe/Oslo" "Europe/Paris" "Europe/Podgorica" "Europe/Prague" "Europe/Riga" "Europe/Rome" "Europe/Samara" "Europe/San_Marino" "Europe/Sarajevo" "Europe/Saratov" "Europe/Simferopol" "Europe/Skopje" "Europe/Sofia" "Europe/Stockholm" "Europe/Tallinn" "Europe/Tirane" "Europe/Tiraspol" "Europe/Ulyanovsk" "Europe/Vaduz" "Europe/Vatican" "Europe/Vienna" "Europe/Vilnius" "Europe/Volgograd" "Europe/Warsaw" "Europe/Zagreb" "Europe/Zurich" "Factory" "GMT" "Indian/Antananarivo" "Indian/Chagos" "Indian/Christmas" "Indian/Cocos" "Indian/Comoro" "Indian/Kerguelen" "Indian/Mahe" "Indian/Maldives" "Indian/Mauritius" "Indian/Mayotte" "Indian/Reunion" "Pacific/Apia" "Pacific/Auckland" "Pacific/Bougainville" "Pacific/Chatham" "Pacific/Chuuk" "Pacific/Easter" "Pacific/Efate" "Pacific/Fakaofo" "Pacific/Fiji" "Pacific/Funafuti" "Pacific/Galapagos" "Pacific/Gambier" "Pacific/Guadalcanal" "Pacific/Guam" "Pacific/Honolulu" "Pacific/Johnston" "Pacific/Kanton" "Pacific/Kiritimati" "Pacific/Kosrae" "Pacific/Kwajalein" "Pacific/Majuro" "Pacific/Marquesas" "Pacific/Midway" "Pacific/Nauru" "Pacific/Niue" "Pacific/Norfolk" "Pacific/Noumea" "Pacific/Pago_Pago" "Pacific/Palau" "Pacific/Pitcairn" "Pacific/Pohnpei" "Pacific/Port_Moresby" "Pacific/Rarotonga" "Pacific/Saipan" "Pacific/Samoa" "Pacific/Tahiti" "Pacific/Tarawa" "Pacific/Tongatapu" "Pacific/Wake" "Pacific/Wallis" "Pacific/Yap" "UTC"
circle_id required	integer
assignee_id	integer or null
vital_sign_measurement_type	string or null Enum: "temperature" "heart_rate" "respiratory_rate" "blood_pressure" "oxygen_saturation" "pain_level" "glucose_level" "weight" "height"
adl_type	string or null Enum: "bathing" "dressing" "eating" "toileting" "transferring" "mobility" "managing_finances" "medication_management" "meal_preparation" "housekeeping" "shopping" "transportation" "communication"
	Array of objects

Responses

Request samples

Payload

Content type

multipart/form-data

{
  "name": "Doctor appointment",
  "notes": "Regular checkup with Dr. Smith",
  "alarm_before_minutes": 5,
  "periodicity_dow": [
    0
  ],
  "start_date": "2023-01-01",
  "start_hour": "14:00",
  "time_zone": "UTC",
  "circle_id": 1,
  "assignee_id": 1,
  "files": [
    {
      "file": "#<ActionDispatch::Http::UploadedFile:0x00007fa8f2ea8a88>",
      "name": "pdf-document.pdf"
    }
  ]
}

Response samples

201
401
403
404
422

Content type

application/json

{"id": 53,
"created_at": "2025-12-05T12:07:10.238052Z",
"event_type": "habit",
"name": "Doctor appointment",
"notes": "Regular checkup with Dr. Smith",
"is_private": false,
"alarm_before_minutes": 5,
"is_all_day": false,
"location": null,
"periodicity_type": "day_of_week",
"periodicity_dow": [0
],
"periodicity_interval": null,
"start_date": "2025-12-07",
"end_date": "2025-12-07",
"start_hour": "14:00",
"end_hour": "14:15",
"hours": null,
"time_zone": "UTC",
"series_end_date": null,
"dosage": null,
"vital_sign_measurement_type": "temperature",
"adl_type": null,
"assignee": {"id": 997,
"full_name": "Rene Simonis Rocky Braun",
"avatar_url": null,
"placeholder_avatar_data": {"initials": "FF",
"background_color": "#FF0000"
}
},
"vault_content_calendar_display": null,
"files": [{"id": 1,
"name": "pdf-document.pdf",
"size": 0,
"file_url": "http://minio:9000/caily-private/private_store/periodic_event_file/1/example-pdf20251205-82-qvuty3-1.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=minioadmin%2F20251205%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20251205T120710Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=c89628ed2fe92047f93c9567034fda181dccacb65b8a9e92862e5a79dd8993a1"
}
]
}

Index habits

Authorizations:

Bearer Token

query Parameters

circle_id required	integer
cursor	string or null <date_time> created_at of the last item that was returned previously
items_per_page	integer or null
direction	string

Responses

Response samples

200
401
403
404
422

Content type

application/json

{"items": [{"id": 55,
"created_at": "2025-12-05T12:07:11.238988Z",
"name": "qui",
"days_of_week": "Su",
"start_hour": "10:00",
"time_zone": "UTC",
"assignee": {"id": 1018,
"full_name": "Gustavo Bogisich Gov. So Jast",
"avatar_url": null,
"placeholder_avatar_data": {"initials": "FF",
"background_color": "#FF0000"
}
},
"has_note": true,
"has_files": false
}
],
"total_count": 2
}

Update habit

Authorizations:

Bearer Token

path Parameters

id

required

integer

Request Body schema: application/json

event_update_type required	string Enum: "all_events" "this_and_future_events" "future_events" when periodicity_type is one_time only 'all_events' is accepted
force	boolean force update, required events are rewritten, should be confirmed by a user
name required	string
notes required	string or null
alarm_before_minutes required	integer or null Alarm before minutes, max 1440
periodicity_dow required	Array of integers Items Enum: 0 1 2 3 4 5 6
start_hour required	string <(?-mix:^(?:[01]\d\|2[0-3]):(?:[0-5]{1}\d{1})$)> Local start hour of the event
assignee_id required	integer or null
calendar_entry_id	integer or null used by this and future entries update type

Responses

Request samples

Payload

Content type

application/json

{"event_update_type": "all_events",
"force": true,
"name": "string",
"notes": "string",
"alarm_before_minutes": 0,
"periodicity_dow": [0
],
"start_hour": "string",
"assignee_id": 0,
"calendar_entry_id": 0
}

Response samples

200
401
403
404
422

Content type

application/json

{"id": 67,
"created_at": "2025-12-05T12:07:11.663668Z",
"event_type": "habit",
"name": "Updated Event",
"notes": "Updated notes",
"is_private": false,
"alarm_before_minutes": null,
"is_all_day": false,
"location": null,
"periodicity_type": "day_of_week",
"periodicity_dow": [1
],
"periodicity_interval": "daily",
"start_date": "2025-12-04",
"end_date": "2025-12-04",
"start_hour": "10:00",
"end_hour": "11:00",
"hours": null,
"time_zone": "UTC",
"series_end_date": null,
"dosage": null,
"vital_sign_measurement_type": null,
"adl_type": null,
"assignee": null,
"vault_content_calendar_display": null,
"files": [ ]
}

[COMMON] Help Requests

Assign help request

Authorizations:

Bearer Token

path Parameters

id

required

integer

Responses

Response samples

401
403
404
422

Content type

application/json

{"error": {"code": "unauthorized",
"details": [{"key": "_base",
"message": "Session has expired"
}
]
}
}

Create help request

Authorizations:

Bearer Token

Request Body schema: application/json
required

circle_id	integer
description	string
task_id	integer

Responses

Request samples

Payload

Content type

application/json

{"circle_id": 1,
"description": "Help request",
"task_id": 1
}

Response samples

201
401
403
404
422

Content type

application/json

{"id": 6,
"description": "Help request",
"creator": {"id": 1090,
"full_name": "Prof. Lucien Jerde Dominick Dickinson",
"avatar_url": null,
"placeholder_avatar_data": {"initials": "FF",
"background_color": "#FF0000"
}
},
"task": {"id": 83,
"name": "a",
"starts_at": "2025-12-05T13:07:12.805772Z",
"assignee": null
},
"created_at": "2025-12-05T12:07:12.832628Z"
}

Index help requests

Authorizations:

Bearer Token

query Parameters

circle_id required	integer
cursor	integer
items_per_page	integer
direction	string

Responses

Response samples

200
401
404
422

Content type

application/json

[ ]

[COMMON] In app notifications

Index in app notifications

Authorizations:

Bearer Token

query Parameters

	object
cursor	integer
items_per_page	integer
direction	string

Responses

Response samples

200
401
422

Content type

application/json

[{"id": 2,
"created_at": "2025-12-04T00:00:00.000000Z",
"title": "Eaque vel consequatur quis.",
"body": "Perferendis fuga quia. Quos voluptatum quo. Dolor dolorum dolorem.",
"is_read": false,
"notification_type": "missed_medication",
"notification_group": "habits",
"redirect_destination": "vault_task",
"redirect_resource_id": null,
"circle_id": null,
"triggered_by_user_avatar_data": null,
"circle_name": null,
"circle_avatar_data": null,
"additional_info": {"adl_type": "dressing"
}
}
]

Mark all as read

Authorizations:

Bearer Token

Responses

Response samples

401

Content type

application/json

{"error": {"code": "unauthorized",
"details": [{"key": "_base",
"message": "Session has expired"
}
]
}
}

Mark as read

Authorizations:

Bearer Token

path Parameters

id

required

integer

Request Body schema: application/json

is_read

required

boolean

Responses

Request samples

Payload

Content type

application/json

{"is_read": true
}

Response samples

200
401
403
404

Content type

application/json

{"id": 11,
"created_at": "2025-12-05T12:07:13.875817Z",
"title": "Ipsa tempore a totam.",
"body": "Dolorum debitis at. Consequuntur saepe qui. Beatae est dicta.",
"is_read": true,
"notification_type": "new_daily_living_activity_log",
"notification_group": "health",
"redirect_destination": "circle_members",
"redirect_resource_id": null,
"circle_id": null,
"triggered_by_user_avatar_data": null,
"circle_name": null,
"circle_avatar_data": null,
"additional_info": null
}

[COMMON] Medical notes

Get medical note categories

Authorizations:

Bearer Token

Responses

Response samples

200
401

Content type

application/json

[{"id": 1,
"name": "Discharge summary"
}
]

Get medical notes

Authorizations:

Bearer Token

query Parameters

circle_id required	integer
	object
search_expression	string Search notes by category title or care facility name
page	integer
items_per_page	integer

Responses

Response samples

200
401
403
404
422

Content type

application/json

{"collection": [ ],
"pagination": {"items_length": 0,
"page": 1,
"page_count": 1
}
}

Get medical note

Authorizations:

Bearer Token

path Parameters

id

required

integer

query Parameters

circle_id

required

integer

Responses

Response samples

200
401
403
404
422

Content type

application/json

{"id": 13,
"date": null,
"practitioner": null,
"care_facility": {"id": 43,
"name": "Ortiz Group"
},
"category": {"id": 9,
"name": "Discharge summary"
},
"content": null,
"files": [{"id": 1,
"name": "example_file.png",
"size": 177392,
"file_url": "http://minio:9000/caily-private/private_store/fb48394bfa912b2e40e757865ec5b452.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=minioadmin%2F20251205%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20251205T120714Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=917a31c592d94bf9cec09adbf5f5a3546c6a2d992eb429d98c7518dbf97de232"
}
]
}

[COMMON] Medications

Create medication

Authorizations:

Bearer Token

Request Body schema: multipart/form-data

name required	string
notes	string or null
alarm_before_minutes	integer or null Alarm before minutes, max 1440
periodicity_dow required	Array of integers Items Enum: 0 1 2 3 4 5 6
hours required	Array of strings Dose hours in 24h format
series_end_date	date or null Local end date of the series, null for endless events, max 10 years after start_date
time_zone required	string Enum: "Africa/Abidjan" "Africa/Accra" "Africa/Addis_Ababa" "Africa/Algiers" "Africa/Asmara" "Africa/Bamako" "Africa/Bangui" "Africa/Banjul" "Africa/Bissau" "Africa/Blantyre" "Africa/Brazzaville" "Africa/Bujumbura" "Africa/Cairo" "Africa/Casablanca" "Africa/Ceuta" "Africa/Conakry" "Africa/Dakar" "Africa/Dar_es_Salaam" "Africa/Djibouti" "Africa/Douala" "Africa/El_Aaiun" "Africa/Freetown" "Africa/Gaborone" "Africa/Harare" "Africa/Johannesburg" "Africa/Juba" "Africa/Kampala" "Africa/Khartoum" "Africa/Kigali" "Africa/Kinshasa" "Africa/Lagos" "Africa/Libreville" "Africa/Lome" "Africa/Luanda" "Africa/Lubumbashi" "Africa/Lusaka" "Africa/Malabo" "Africa/Maputo" "Africa/Maseru" "Africa/Mbabane" "Africa/Mogadishu" "Africa/Monrovia" "Africa/Nairobi" "Africa/Ndjamena" "Africa/Niamey" "Africa/Nouakchott" "Africa/Ouagadougou" "Africa/Porto-Novo" "Africa/Sao_Tome" "Africa/Timbuktu" "Africa/Tripoli" "Africa/Tunis" "Africa/Windhoek" "America/Adak" "America/Anchorage" "America/Anguilla" "America/Antigua" "America/Araguaina" "America/Argentina/Buenos_Aires" "America/Argentina/Catamarca" "America/Argentina/Cordoba" "America/Argentina/Jujuy" "America/Argentina/La_Rioja" "America/Argentina/Mendoza" "America/Argentina/Rio_Gallegos" "America/Argentina/Salta" "America/Argentina/San_Juan" "America/Argentina/San_Luis" "America/Argentina/Tucuman" "America/Argentina/Ushuaia" "America/Aruba" "America/Asuncion" "America/Atikokan" "America/Atka" "America/Bahia" "America/Bahia_Banderas" "America/Barbados" "America/Belem" "America/Belize" "America/Blanc-Sablon" "America/Boa_Vista" "America/Bogota" "America/Boise" "America/Cambridge_Bay" "America/Campo_Grande" "America/Cancun" "America/Caracas" "America/Cayenne" "America/Cayman" "America/Chicago" "America/Chihuahua" "America/Ciudad_Juarez" "America/Coral_Harbour" "America/Costa_Rica" "America/Creston" "America/Cuiaba" "America/Curacao" "America/Danmarkshavn" "America/Dawson" "America/Dawson_Creek" "America/Denver" "America/Detroit" "America/Dominica" "America/Edmonton" "America/Eirunepe" "America/El_Salvador" "America/Ensenada" "America/Fort_Nelson" "America/Fortaleza" "America/Glace_Bay" "America/Goose_Bay" "America/Grand_Turk" "America/Grenada" "America/Guadeloupe" "America/Guatemala" "America/Guayaquil" "America/Guyana" "America/Halifax" "America/Havana" "America/Hermosillo" "America/Indiana/Indianapolis" "America/Indiana/Knox" "America/Indiana/Marengo" "America/Indiana/Petersburg" "America/Indiana/Tell_City" "America/Indiana/Vevay" "America/Indiana/Vincennes" "America/Indiana/Winamac" "America/Inuvik" "America/Iqaluit" "America/Jamaica" "America/Juneau" "America/Kentucky/Louisville" "America/Kentucky/Monticello" "America/Kralendijk" "America/La_Paz" "America/Lima" "America/Los_Angeles" "America/Lower_Princes" "America/Maceio" "America/Managua" "America/Manaus" "America/Marigot" "America/Martinique" "America/Matamoros" "America/Mazatlan" "America/Menominee" "America/Merida" "America/Metlakatla" "America/Mexico_City" "America/Miquelon" "America/Moncton" "America/Monterrey" "America/Montevideo" "America/Montreal" "America/Montserrat" "America/Nassau" "America/New_York" "America/Nipigon" "America/Nome" "America/Noronha" "America/North_Dakota/Beulah" "America/North_Dakota/Center" "America/North_Dakota/New_Salem" "America/Nuuk" "America/Ojinaga" "America/Panama" "America/Pangnirtung" "America/Paramaribo" "America/Phoenix" "America/Port-au-Prince" "America/Port_of_Spain" "America/Porto_Acre" "America/Porto_Velho" "America/Puerto_Rico" "America/Punta_Arenas" "America/Rainy_River" "America/Rankin_Inlet" "America/Recife" "America/Regina" "America/Resolute" "America/Rio_Branco" "America/Santa_Isabel" "America/Santarem" "America/Santiago" "America/Santo_Domingo" "America/Sao_Paulo" "America/Scoresbysund" "America/Shiprock" "America/Sitka" "America/St_Barthelemy" "America/St_Johns" "America/St_Kitts" "America/St_Lucia" "America/St_Thomas" "America/St_Vincent" "America/Swift_Current" "America/Tegucigalpa" "America/Thule" "America/Thunder_Bay" "America/Tijuana" "America/Toronto" "America/Tortola" "America/Vancouver" "America/Virgin" "America/Whitehorse" "America/Winnipeg" "America/Yakutat" "America/Yellowknife" "Antarctica/Casey" "Antarctica/Davis" "Antarctica/DumontDUrville" "Antarctica/Macquarie" "Antarctica/Mawson" "Antarctica/McMurdo" "Antarctica/Palmer" "Antarctica/Rothera" "Antarctica/Syowa" "Antarctica/Troll" "Antarctica/Vostok" "Arctic/Longyearbyen" "Asia/Aden" "Asia/Almaty" "Asia/Amman" "Asia/Anadyr" "Asia/Aqtau" "Asia/Aqtobe" "Asia/Ashgabat" "Asia/Atyrau" "Asia/Baghdad" "Asia/Bahrain" "Asia/Baku" "Asia/Bangkok" "Asia/Barnaul" "Asia/Beirut" "Asia/Bishkek" "Asia/Brunei" "Asia/Chita" "Asia/Chongqing" "Asia/Colombo" "Asia/Damascus" "Asia/Dhaka" "Asia/Dili" "Asia/Dubai" "Asia/Dushanbe" "Asia/Famagusta" "Asia/Gaza" "Asia/Harbin" "Asia/Hebron" "Asia/Ho_Chi_Minh" "Asia/Hong_Kong" "Asia/Hovd" "Asia/Irkutsk" "Asia/Istanbul" "Asia/Jakarta" "Asia/Jayapura" "Asia/Jerusalem" "Asia/Kabul" "Asia/Kamchatka" "Asia/Karachi" "Asia/Kashgar" "Asia/Kathmandu" "Asia/Khandyga" "Asia/Kolkata" "Asia/Krasnoyarsk" "Asia/Kuala_Lumpur" "Asia/Kuching" "Asia/Kuwait" "Asia/Macau" "Asia/Magadan" "Asia/Makassar" "Asia/Manila" "Asia/Muscat" "Asia/Nicosia" "Asia/Novokuznetsk" "Asia/Novosibirsk" "Asia/Omsk" "Asia/Oral" "Asia/Phnom_Penh" "Asia/Pontianak" "Asia/Pyongyang" "Asia/Qatar" "Asia/Qostanay" "Asia/Qyzylorda" "Asia/Riyadh" "Asia/Sakhalin" "Asia/Samarkand" "Asia/Seoul" "Asia/Shanghai" "Asia/Singapore" "Asia/Srednekolymsk" "Asia/Taipei" "Asia/Tashkent" "Asia/Tbilisi" "Asia/Tehran" "Asia/Tel_Aviv" "Asia/Thimphu" "Asia/Tokyo" "Asia/Tomsk" "Asia/Ulaanbaatar" "Asia/Urumqi" "Asia/Ust-Nera" "Asia/Vientiane" "Asia/Vladivostok" "Asia/Yakutsk" "Asia/Yangon" "Asia/Yekaterinburg" "Asia/Yerevan" "Atlantic/Azores" "Atlantic/Bermuda" "Atlantic/Canary" "Atlantic/Cape_Verde" "Atlantic/Faroe" "Atlantic/Jan_Mayen" "Atlantic/Madeira" "Atlantic/Reykjavik" "Atlantic/South_Georgia" "Atlantic/St_Helena" "Atlantic/Stanley" "Australia/Adelaide" "Australia/Brisbane" "Australia/Broken_Hill" "Australia/Canberra" "Australia/Currie" "Australia/Darwin" "Australia/Eucla" "Australia/Hobart" "Australia/Lindeman" "Australia/Lord_Howe" "Australia/Melbourne" "Australia/Perth" "Australia/Sydney" "Australia/Yancowinna" "Etc/GMT" "Etc/GMT+0" "Etc/GMT+1" "Etc/GMT+10" "Etc/GMT+11" "Etc/GMT+12" "Etc/GMT+2" "Etc/GMT+3" "Etc/GMT+4" "Etc/GMT+5" "Etc/GMT+6" "Etc/GMT+7" "Etc/GMT+8" "Etc/GMT+9" "Etc/GMT-0" "Etc/GMT-1" "Etc/GMT-10" "Etc/GMT-11" "Etc/GMT-12" "Etc/GMT-13" "Etc/GMT-14" "Etc/GMT-2" "Etc/GMT-3" "Etc/GMT-4" "Etc/GMT-5" "Etc/GMT-6" "Etc/GMT-7" "Etc/GMT-8" "Etc/GMT-9" "Etc/GMT0" "Etc/Greenwich" "Etc/UCT" "Etc/UTC" "Etc/Universal" "Etc/Zulu" "Europe/Amsterdam" "Europe/Andorra" "Europe/Astrakhan" "Europe/Athens" "Europe/Belfast" "Europe/Belgrade" "Europe/Berlin" "Europe/Bratislava" "Europe/Brussels" "Europe/Bucharest" "Europe/Budapest" "Europe/Busingen" "Europe/Chisinau" "Europe/Copenhagen" "Europe/Dublin" "Europe/Gibraltar" "Europe/Guernsey" "Europe/Helsinki" "Europe/Isle_of_Man" "Europe/Istanbul" "Europe/Jersey" "Europe/Kaliningrad" "Europe/Kirov" "Europe/Kyiv" "Europe/Lisbon" "Europe/Ljubljana" "Europe/London" "Europe/Luxembourg" "Europe/Madrid" "Europe/Malta" "Europe/Mariehamn" "Europe/Minsk" "Europe/Monaco" "Europe/Moscow" "Europe/Nicosia" "Europe/Oslo" "Europe/Paris" "Europe/Podgorica" "Europe/Prague" "Europe/Riga" "Europe/Rome" "Europe/Samara" "Europe/San_Marino" "Europe/Sarajevo" "Europe/Saratov" "Europe/Simferopol" "Europe/Skopje" "Europe/Sofia" "Europe/Stockholm" "Europe/Tallinn" "Europe/Tirane" "Europe/Tiraspol" "Europe/Ulyanovsk" "Europe/Vaduz" "Europe/Vatican" "Europe/Vienna" "Europe/Vilnius" "Europe/Volgograd" "Europe/Warsaw" "Europe/Zagreb" "Europe/Zurich" "Factory" "GMT" "Indian/Antananarivo" "Indian/Chagos" "Indian/Christmas" "Indian/Cocos" "Indian/Comoro" "Indian/Kerguelen" "Indian/Mahe" "Indian/Maldives" "Indian/Mauritius" "Indian/Mayotte" "Indian/Reunion" "Pacific/Apia" "Pacific/Auckland" "Pacific/Bougainville" "Pacific/Chatham" "Pacific/Chuuk" "Pacific/Easter" "Pacific/Efate" "Pacific/Fakaofo" "Pacific/Fiji" "Pacific/Funafuti" "Pacific/Galapagos" "Pacific/Gambier" "Pacific/Guadalcanal" "Pacific/Guam" "Pacific/Honolulu" "Pacific/Johnston" "Pacific/Kanton" "Pacific/Kiritimati" "Pacific/Kosrae" "Pacific/Kwajalein" "Pacific/Majuro" "Pacific/Marquesas" "Pacific/Midway" "Pacific/Nauru" "Pacific/Niue" "Pacific/Norfolk" "Pacific/Noumea" "Pacific/Pago_Pago" "Pacific/Palau" "Pacific/Pitcairn" "Pacific/Pohnpei" "Pacific/Port_Moresby" "Pacific/Rarotonga" "Pacific/Saipan" "Pacific/Samoa" "Pacific/Tahiti" "Pacific/Tarawa" "Pacific/Tongatapu" "Pacific/Wake" "Pacific/Wallis" "Pacific/Yap" "UTC"
circle_id required	integer
assignee_id	integer or null
dosage	string or null
cover_photo	string or null <binary>

Responses

Request samples

Payload

Content type

multipart/form-data

{
  "name": "Doctor appointment",
  "notes": "Regular checkup with Dr. Smith",
  "alarm_before_minutes": 5,
  "periodicity_dow": [
    3,
    5
  ],
  "hours": [
    "14:00",
    "15:00"
  ],
  "series_end_date": "2025-01-31",
  "time_zone": "UTC",
  "circle_id": 1,
  "assignee_id": 1,
  "dosage": "10 mg",
  "cover_photo": "#<ActionDispatch::Http::UploadedFile:0x00007fa8dc2e5ce8>"
}

Response samples

201
401
403
404
422

Content type

application/json

{"id": 98,
"created_at": "2025-12-05T12:07:15.184510Z",
"event_type": "medication",
"name": "Doctor appointment",
"notes": "Regular checkup with Dr. Smith",
"is_private": false,
"alarm_before_minutes": 5,
"is_all_day": false,
"location": null,
"periodicity_type": "day_of_week",
"periodicity_dow": [3,
5
],
"periodicity_interval": null,
"start_date": "2025-12-05",
"end_date": null,
"start_hour": null,
"end_hour": null,
"hours": ["14:00",
"15:00"
],
"time_zone": "UTC",
"series_end_date": "2025-01-31",
"dosage": "10 mg",
"vital_sign_measurement_type": null,
"adl_type": null,
"assignee": {"id": 1146,
"full_name": "Freddie Gleason Shannon Schneider I",
"avatar_url": null,
"placeholder_avatar_data": {"initials": "FF",
"background_color": "#FF0000"
}
},
"vault_content_calendar_display": null,
"files": [{"id": 3,
"name": "example-image20251205-82-frrywj.png",
"size": 0,
"file_url": "http://minio:9000/caily-private/private_store/periodic_event_file/3/example-image20251205-82-frrywj-3.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=minioadmin%2F20251205%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20251205T120715Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=a159c6e14c184008f133f355df5e65f610345c4ce496efc116db062abc41bc9e"
}
]
}

Index medications

Authorizations:

Bearer Token

query Parameters

circle_id required	integer
search_expression	string Search by medication name
cursor	string or null <date_time> created_at of the last item that was returned previously
items_per_page	integer or null
direction	string

Responses

Response samples

200
401
403
404
422

Content type

application/json

{"items": [ ],
"total_count": 0
}

Update medication

Authorizations:

Bearer Token

path Parameters

id

required

integer

Request Body schema: multipart/form-data

event_update_type required	string Enum: "all_events" "this_and_future_events" "future_events"
force	boolean force update, calendar entries are rewritten, should be confirmed by a user
name required	string
notes	string or null
alarm_before_minutes	integer or null Alarm before minutes, max 1440
periodicity_dow required	Array of integers Items Enum: 0 1 2 3 4 5 6
hours required	Array of strings <(?-mix:^(?:[01]\d\|2[0-3]):(?:[0-5]{1}\d{1})$)> [ items <(?-mix:^(?:[01]\d\|2[0-3]):(?:[0-5]{1}\d{1})$) > ]
series_end_date	string or null <date> End date of the series, null for endless events
assignee_id	integer or null
dosage	string or null
cover_photo	string or null <binary>
calendar_entry_id	integer or null used by this and future entries update type

Responses

Response samples

200
401
403
404
422

Content type

application/json

{"id": 112,
"created_at": "2025-12-05T12:07:16.329599Z",
"event_type": "medication",
"name": "necessitatibus",
"notes": "Dolor magni quia et.",
"is_private": false,
"alarm_before_minutes": null,
"is_all_day": false,
"location": null,
"periodicity_type": "day_of_week",
"periodicity_dow": [1
],
"periodicity_interval": null,
"start_date": "2025-12-04",
"end_date": "2025-12-04",
"start_hour": "10:00",
"end_hour": "11:00",
"hours": ["12:00"
],
"time_zone": "UTC",
"series_end_date": null,
"dosage": null,
"vital_sign_measurement_type": null,
"adl_type": null,
"assignee": null,
"vault_content_calendar_display": null,
"files": [{"id": 5,
"name": "example-image20251205-82-wy0jdn.png",
"size": 0,
"file_url": "http://minio:9000/caily-private/private_store/periodic_event_file/5/example-image20251205-82-wy0jdn-5.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=minioadmin%2F20251205%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20251205T120716Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=7528211a70e5e0dcc34ef7cd2e08228f6136b5acf6b061a4c98d65550782c138"
}
]
}

[COMMON] Note Files

Create note file

Authorizations:

Bearer Token

Request Body schema: multipart/form-data

note_id required	integer
file required	string <binary>
name	string

Responses

Request samples

Payload

Content type

multipart/form-data

{
  "note_id": 1,
  "file": "#<ActionDispatch::Http::UploadedFile:0x00007fa8dc6b2ee8>",
  "name": "pdf-document.pdf"
}

Response samples

201
403
404
422

Content type

application/json

{"id": 1,
"name": "Doctor appointment",
"size": 0,
"file_url": "http://minio:9000/caily-private/private_store/note_file/1/example-pdf20251205-82-pfvrxy-1.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=minioadmin%2F20251205%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20251205T120717Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=50661a0d458663e31dae0b83f929e886d0b93c3c77c5fb0763c1f16cec439d39"
}

Delete note file

Authorizations:

Bearer Token

path Parameters

id

required

integer

Responses

Response samples

403
404
422

Content type

application/json

{"error": {"code": "authorize",
"details": [{"key": "_base",
"message": "You don't have permission to access this space. Please contact your Circle Admin to update your permissions"
}
]
}
}

[COMMON] Notes

Create notes

Authorizations:

Bearer Token

path Parameters

circle_id

required

integer

Request Body schema: application/json
required

title	string or null is required when content is null
content	string or null is required when title is null
note_folder_id	integer or null

Responses

Request samples

Payload

Content type

application/json

{"title": "string",
"content": "string",
"note_folder_id": 0
}

Response samples

201
401
403
404
422

Content type

application/json

{"id": 18,
"title": "Medical",
"content": "This is a test note.",
"note_folder_name": null,
"note_folder_id": null,
"files": [ ],
"created_by": "Chiquita Conn Jane Flatley",
"feature_permissions": [{"id": 478,
"feature_type": null,
"permission_type": "edit",
"user_id": 1283,
"user_email": "user1283@example.com",
"user_first_name": "Chiquita Conn",
"user_last_name": "Jane Flatley",
"user_avatar_url": null,
"user_placeholder_avatar_data": {"initials": "FF",
"background_color": "#FF0000"
},
"user_roles": [ ],
"circle_id": 688
},
{"id": 479,
"feature_type": null,
"permission_type": "read",
"user_id": 1285,
"user_email": "user1285@example.com",
"user_first_name": "Norris Roob",
"user_last_name": "Irene Davis",
"user_avatar_url": null,
"user_placeholder_avatar_data": {"initials": "FF",
"background_color": "#FF0000"
},
"user_roles": ["admin"
],
"circle_id": 688
}
]
}

Delete note

Authorizations:

Bearer Token

path Parameters

id

required

integer

Responses

Response samples

401
403
404
422

Content type

application/json

{"error": {"code": "unauthorized",
"details": [{"key": "_base",
"message": "Session has expired"
}
]
}
}

Show note

Authorizations:

Bearer Token

path Parameters

id

required

integer

Responses

Response samples

200
401
403
404
422

Content type

application/json

{"id": 25,
"title": "suscipit",
"content": "Id omnis aspernatur. Quod non libero. Voluptas accusantium nemo.",
"note_folder_name": "harum",
"note_folder_id": 47,
"files": [{"id": 8,
"name": "example_file.png",
"size": 0,
"file_url": "http://minio:9000/caily-private/private_store/fb48394bfa912b2e40e757865ec5b452.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=minioadmin%2F20251205%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20251205T120720Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=f9a19f2915821c60c6687bfd1ac0ce6b14bee965a5eb665e3c37d4913eb7d09d"
}
],
"created_by": "Dr. Consuela Frami Fr. Ricki Weimann",
"feature_permissions": [{"id": 492,
"feature_type": null,
"permission_type": "edit",
"user_id": 1322,
"user_email": "user1322@example.com",
"user_first_name": "Jack Hilll",
"user_last_name": "Sen. Ira Ziemann",
"user_avatar_url": null,
"user_placeholder_avatar_data": {"initials": "FF",
"background_color": "#FF0000"
},
"user_roles": ["admin"
],
"circle_id": 707
}
]
}

Update note

Authorizations:

Bearer Token

path Parameters

id

required

integer

Request Body schema: application/json

title	string or null
content	string or null
note_folder_id	integer or null
	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"title": "string",
"content": "string",
"note_folder_id": 0,
"permissions": [{"user_id": 0,
"permission_type": "string"
}
]
}

Response samples

200
401
403
404
422

Content type

application/json

{"id": 31,
"title": "Medical",
"content": "This is a test note.",
"note_folder_name": null,
"note_folder_id": null,
"files": [ ],
"created_by": "Nick Schoen Reina Pfannerstill",
"feature_permissions": [{"id": 498,
"feature_type": null,
"permission_type": "edit",
"user_id": 1340,
"user_email": "user1340@example.com",
"user_first_name": "Wilford Tromp",
"user_last_name": "Carylon Kessler",
"user_avatar_url": null,
"user_placeholder_avatar_data": {"initials": "FF",
"background_color": "#FF0000"
},
"user_roles": ["admin"
],
"circle_id": 719
}
]
}

[COMMON] Organization Invitations

Accept organization invitation

Authorizations:

Bearer Token

Request Body schema: application/json

invitation_token

required

string

Responses

Request samples

Payload

Content type

application/json

{"invitation_token": "string"
}

Response samples

401
404
422

Content type

application/json

{"error": {"code": "unauthorized",
"details": [{"key": "_base",
"message": "Session has expired"
}
]
}
}

Retrieve organization invitation by token

Authorizations:

Bearer Token

query Parameters

invitation_token

string

Responses

Response samples

200
401
404
422

Content type

application/json

{"organization_name": "Swift and Sons 149"
}

[COMMON] Periodic Event Files

Create periodic event file

Authorizations:

Bearer Token

Request Body schema: multipart/form-data

periodic_event_id required	integer
file required	string <binary>
name	string

Responses

Request samples

Payload

Content type

multipart/form-data

{
  "periodic_event_id": 1,
  "file": "#<ActionDispatch::Http::UploadedFile:0x00007fa8dd12e930>",
  "name": "pdf-document.pdf"
}

Response samples

201
403
404
422

Content type

application/json

{"id": 7,
"name": "Doctor appointment",
"size": 0,
"file_url": "http://minio:9000/caily-private/private_store/periodic_event_file/7/example-pdf20251205-82-307al6-7.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=minioadmin%2F20251205%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20251205T120722Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=50af0349264675944f994251f567fdd0fe5b6aa21fe39399ca6a4d026a735ef1"
}

Delete periodic event file

Authorizations:

Bearer Token

path Parameters

id

required

integer

Responses

Response samples

403
404
422

Content type

application/json

{"error": {"code": "authorize",
"details": [{"key": "_base",
"message": "You don't have permission to access this space. Please contact your Circle Admin to update your permissions"
}
]
}
}

[COMMON] Periodic Events

Create periodic event

Authorizations:

Bearer Token

Request Body schema: multipart/form-data

name required	string
notes	string or null
	object or null
is_private	boolean
alarm_before_minutes	integer or null Alarm before minutes, max 1440
periodicity_type required	string Enum: "one_time" "interval" "day_of_week"
periodicity_interval	string Enum: "daily" "weekly" "every_two_weeks" "monthly" "yearly" required when periodicity_type is interval
periodicity_dow	Array of integers Items Enum: 0 1 2 3 4 5 6
start_date required	date Local start date of the series, max 2 months in the past
end_date required	date Local end date of the series
start_hour	string or null <(?-mix:^(?:[01]\d\|2[0-3]):(?:[0-5]{1}\d{1})$)> Local start hour of the event
end_hour	string or null <(?-mix:^(?:[01]\d\|2[0-3]):(?:[0-5]{1}\d{1})$)> Local end hour of the event, max 24 hours after start_hour
series_end_date	date or null Local end date of the series, null for endless events, max 10 years after start_date
is_all_day	boolean
time_zone required	string Enum: "Africa/Abidjan" "Africa/Accra" "Africa/Addis_Ababa" "Africa/Algiers" "Africa/Asmara" "Africa/Bamako" "Africa/Bangui" "Africa/Banjul" "Africa/Bissau" "Africa/Blantyre" "Africa/Brazzaville" "Africa/Bujumbura" "Africa/Cairo" "Africa/Casablanca" "Africa/Ceuta" "Africa/Conakry" "Africa/Dakar" "Africa/Dar_es_Salaam" "Africa/Djibouti" "Africa/Douala" "Africa/El_Aaiun" "Africa/Freetown" "Africa/Gaborone" "Africa/Harare" "Africa/Johannesburg" "Africa/Juba" "Africa/Kampala" "Africa/Khartoum" "Africa/Kigali" "Africa/Kinshasa" "Africa/Lagos" "Africa/Libreville" "Africa/Lome" "Africa/Luanda" "Africa/Lubumbashi" "Africa/Lusaka" "Africa/Malabo" "Africa/Maputo" "Africa/Maseru" "Africa/Mbabane" "Africa/Mogadishu" "Africa/Monrovia" "Africa/Nairobi" "Africa/Ndjamena" "Africa/Niamey" "Africa/Nouakchott" "Africa/Ouagadougou" "Africa/Porto-Novo" "Africa/Sao_Tome" "Africa/Timbuktu" "Africa/Tripoli" "Africa/Tunis" "Africa/Windhoek" "America/Adak" "America/Anchorage" "America/Anguilla" "America/Antigua" "America/Araguaina" "America/Argentina/Buenos_Aires" "America/Argentina/Catamarca" "America/Argentina/Cordoba" "America/Argentina/Jujuy" "America/Argentina/La_Rioja" "America/Argentina/Mendoza" "America/Argentina/Rio_Gallegos" "America/Argentina/Salta" "America/Argentina/San_Juan" "America/Argentina/San_Luis" "America/Argentina/Tucuman" "America/Argentina/Ushuaia" "America/Aruba" "America/Asuncion" "America/Atikokan" "America/Atka" "America/Bahia" "America/Bahia_Banderas" "America/Barbados" "America/Belem" "America/Belize" "America/Blanc-Sablon" "America/Boa_Vista" "America/Bogota" "America/Boise" "America/Cambridge_Bay" "America/Campo_Grande" "America/Cancun" "America/Caracas" "America/Cayenne" "America/Cayman" "America/Chicago" "America/Chihuahua" "America/Ciudad_Juarez" "America/Coral_Harbour" "America/Costa_Rica" "America/Creston" "America/Cuiaba" "America/Curacao" "America/Danmarkshavn" "America/Dawson" "America/Dawson_Creek" "America/Denver" "America/Detroit" "America/Dominica" "America/Edmonton" "America/Eirunepe" "America/El_Salvador" "America/Ensenada" "America/Fort_Nelson" "America/Fortaleza" "America/Glace_Bay" "America/Goose_Bay" "America/Grand_Turk" "America/Grenada" "America/Guadeloupe" "America/Guatemala" "America/Guayaquil" "America/Guyana" "America/Halifax" "America/Havana" "America/Hermosillo" "America/Indiana/Indianapolis" "America/Indiana/Knox" "America/Indiana/Marengo" "America/Indiana/Petersburg" "America/Indiana/Tell_City" "America/Indiana/Vevay" "America/Indiana/Vincennes" "America/Indiana/Winamac" "America/Inuvik" "America/Iqaluit" "America/Jamaica" "America/Juneau" "America/Kentucky/Louisville" "America/Kentucky/Monticello" "America/Kralendijk" "America/La_Paz" "America/Lima" "America/Los_Angeles" "America/Lower_Princes" "America/Maceio" "America/Managua" "America/Manaus" "America/Marigot" "America/Martinique" "America/Matamoros" "America/Mazatlan" "America/Menominee" "America/Merida" "America/Metlakatla" "America/Mexico_City" "America/Miquelon" "America/Moncton" "America/Monterrey" "America/Montevideo" "America/Montreal" "America/Montserrat" "America/Nassau" "America/New_York" "America/Nipigon" "America/Nome" "America/Noronha" "America/North_Dakota/Beulah" "America/North_Dakota/Center" "America/North_Dakota/New_Salem" "America/Nuuk" "America/Ojinaga" "America/Panama" "America/Pangnirtung" "America/Paramaribo" "America/Phoenix" "America/Port-au-Prince" "America/Port_of_Spain" "America/Porto_Acre" "America/Porto_Velho" "America/Puerto_Rico" "America/Punta_Arenas" "America/Rainy_River" "America/Rankin_Inlet" "America/Recife" "America/Regina" "America/Resolute" "America/Rio_Branco" "America/Santa_Isabel" "America/Santarem" "America/Santiago" "America/Santo_Domingo" "America/Sao_Paulo" "America/Scoresbysund" "America/Shiprock" "America/Sitka" "America/St_Barthelemy" "America/St_Johns" "America/St_Kitts" "America/St_Lucia" "America/St_Thomas" "America/St_Vincent" "America/Swift_Current" "America/Tegucigalpa" "America/Thule" "America/Thunder_Bay" "America/Tijuana" "America/Toronto" "America/Tortola" "America/Vancouver" "America/Virgin" "America/Whitehorse" "America/Winnipeg" "America/Yakutat" "America/Yellowknife" "Antarctica/Casey" "Antarctica/Davis" "Antarctica/DumontDUrville" "Antarctica/Macquarie" "Antarctica/Mawson" "Antarctica/McMurdo" "Antarctica/Palmer" "Antarctica/Rothera" "Antarctica/Syowa" "Antarctica/Troll" "Antarctica/Vostok" "Arctic/Longyearbyen" "Asia/Aden" "Asia/Almaty" "Asia/Amman" "Asia/Anadyr" "Asia/Aqtau" "Asia/Aqtobe" "Asia/Ashgabat" "Asia/Atyrau" "Asia/Baghdad" "Asia/Bahrain" "Asia/Baku" "Asia/Bangkok" "Asia/Barnaul" "Asia/Beirut" "Asia/Bishkek" "Asia/Brunei" "Asia/Chita" "Asia/Chongqing" "Asia/Colombo" "Asia/Damascus" "Asia/Dhaka" "Asia/Dili" "Asia/Dubai" "Asia/Dushanbe" "Asia/Famagusta" "Asia/Gaza" "Asia/Harbin" "Asia/Hebron" "Asia/Ho_Chi_Minh" "Asia/Hong_Kong" "Asia/Hovd" "Asia/Irkutsk" "Asia/Istanbul" "Asia/Jakarta" "Asia/Jayapura" "Asia/Jerusalem" "Asia/Kabul" "Asia/Kamchatka" "Asia/Karachi" "Asia/Kashgar" "Asia/Kathmandu" "Asia/Khandyga" "Asia/Kolkata" "Asia/Krasnoyarsk" "Asia/Kuala_Lumpur" "Asia/Kuching" "Asia/Kuwait" "Asia/Macau" "Asia/Magadan" "Asia/Makassar" "Asia/Manila" "Asia/Muscat" "Asia/Nicosia" "Asia/Novokuznetsk" "Asia/Novosibirsk" "Asia/Omsk" "Asia/Oral" "Asia/Phnom_Penh" "Asia/Pontianak" "Asia/Pyongyang" "Asia/Qatar" "Asia/Qostanay" "Asia/Qyzylorda" "Asia/Riyadh" "Asia/Sakhalin" "Asia/Samarkand" "Asia/Seoul" "Asia/Shanghai" "Asia/Singapore" "Asia/Srednekolymsk" "Asia/Taipei" "Asia/Tashkent" "Asia/Tbilisi" "Asia/Tehran" "Asia/Tel_Aviv" "Asia/Thimphu" "Asia/Tokyo" "Asia/Tomsk" "Asia/Ulaanbaatar" "Asia/Urumqi" "Asia/Ust-Nera" "Asia/Vientiane" "Asia/Vladivostok" "Asia/Yakutsk" "Asia/Yangon" "Asia/Yekaterinburg" "Asia/Yerevan" "Atlantic/Azores" "Atlantic/Bermuda" "Atlantic/Canary" "Atlantic/Cape_Verde" "Atlantic/Faroe" "Atlantic/Jan_Mayen" "Atlantic/Madeira" "Atlantic/Reykjavik" "Atlantic/South_Georgia" "Atlantic/St_Helena" "Atlantic/Stanley" "Australia/Adelaide" "Australia/Brisbane" "Australia/Broken_Hill" "Australia/Canberra" "Australia/Currie" "Australia/Darwin" "Australia/Eucla" "Australia/Hobart" "Australia/Lindeman" "Australia/Lord_Howe" "Australia/Melbourne" "Australia/Perth" "Australia/Sydney" "Australia/Yancowinna" "Etc/GMT" "Etc/GMT+0" "Etc/GMT+1" "Etc/GMT+10" "Etc/GMT+11" "Etc/GMT+12" "Etc/GMT+2" "Etc/GMT+3" "Etc/GMT+4" "Etc/GMT+5" "Etc/GMT+6" "Etc/GMT+7" "Etc/GMT+8" "Etc/GMT+9" "Etc/GMT-0" "Etc/GMT-1" "Etc/GMT-10" "Etc/GMT-11" "Etc/GMT-12" "Etc/GMT-13" "Etc/GMT-14" "Etc/GMT-2" "Etc/GMT-3" "Etc/GMT-4" "Etc/GMT-5" "Etc/GMT-6" "Etc/GMT-7" "Etc/GMT-8" "Etc/GMT-9" "Etc/GMT0" "Etc/Greenwich" "Etc/UCT" "Etc/UTC" "Etc/Universal" "Etc/Zulu" "Europe/Amsterdam" "Europe/Andorra" "Europe/Astrakhan" "Europe/Athens" "Europe/Belfast" "Europe/Belgrade" "Europe/Berlin" "Europe/Bratislava" "Europe/Brussels" "Europe/Bucharest" "Europe/Budapest" "Europe/Busingen" "Europe/Chisinau" "Europe/Copenhagen" "Europe/Dublin" "Europe/Gibraltar" "Europe/Guernsey" "Europe/Helsinki" "Europe/Isle_of_Man" "Europe/Istanbul" "Europe/Jersey" "Europe/Kaliningrad" "Europe/Kirov" "Europe/Kyiv" "Europe/Lisbon" "Europe/Ljubljana" "Europe/London" "Europe/Luxembourg" "Europe/Madrid" "Europe/Malta" "Europe/Mariehamn" "Europe/Minsk" "Europe/Monaco" "Europe/Moscow" "Europe/Nicosia" "Europe/Oslo" "Europe/Paris" "Europe/Podgorica" "Europe/Prague" "Europe/Riga" "Europe/Rome" "Europe/Samara" "Europe/San_Marino" "Europe/Sarajevo" "Europe/Saratov" "Europe/Simferopol" "Europe/Skopje" "Europe/Sofia" "Europe/Stockholm" "Europe/Tallinn" "Europe/Tirane" "Europe/Tiraspol" "Europe/Ulyanovsk" "Europe/Vaduz" "Europe/Vatican" "Europe/Vienna" "Europe/Vilnius" "Europe/Volgograd" "Europe/Warsaw" "Europe/Zagreb" "Europe/Zurich" "Factory" "GMT" "Indian/Antananarivo" "Indian/Chagos" "Indian/Christmas" "Indian/Cocos" "Indian/Comoro" "Indian/Kerguelen" "Indian/Mahe" "Indian/Maldives" "Indian/Mauritius" "Indian/Mayotte" "Indian/Reunion" "Pacific/Apia" "Pacific/Auckland" "Pacific/Bougainville" "Pacific/Chatham" "Pacific/Chuuk" "Pacific/Easter" "Pacific/Efate" "Pacific/Fakaofo" "Pacific/Fiji" "Pacific/Funafuti" "Pacific/Galapagos" "Pacific/Gambier" "Pacific/Guadalcanal" "Pacific/Guam" "Pacific/Honolulu" "Pacific/Johnston" "Pacific/Kanton" "Pacific/Kiritimati" "Pacific/Kosrae" "Pacific/Kwajalein" "Pacific/Majuro" "Pacific/Marquesas" "Pacific/Midway" "Pacific/Nauru" "Pacific/Niue" "Pacific/Norfolk" "Pacific/Noumea" "Pacific/Pago_Pago" "Pacific/Palau" "Pacific/Pitcairn" "Pacific/Pohnpei" "Pacific/Port_Moresby" "Pacific/Rarotonga" "Pacific/Saipan" "Pacific/Samoa" "Pacific/Tahiti" "Pacific/Tarawa" "Pacific/Tongatapu" "Pacific/Wake" "Pacific/Wallis" "Pacific/Yap" "UTC"
circle_id required	integer
assignee_id	integer or null Only current user is allowed for private events
	Array of objects

Responses

Request samples

Payload

Content type

multipart/form-data

{
  "name": "Doctor appointment",
  "notes": "Regular checkup with Dr. Smith",
  "location": "./spec/requests/common/periodic_events/create_spec.rb:7",
  "is_private": false,
  "alarm_before_minutes": 5,
  "periodicity_type": "interval",
  "periodicity_interval": "monthly",
  "start_date": "2023-01-01",
  "end_date": "2023-01-01",
  "start_hour": "14:00",
  "end_hour": "15:00",
  "series_end_date": "2023-12-31",
  "is_all_day": false,
  "time_zone": "UTC",
  "circle_id": 1,
  "assignee_id": 1,
  "files": [
    {
      "file": "#<ActionDispatch::Http::UploadedFile:0x00007fa8dd26cea0>",
      "name": "pdf-document.pdf"
    }
  ]
}

Response samples

201
401
403
404
422

Content type

application/json

{"id": 136,
"created_at": "2025-12-05T12:07:22.908456Z",
"event_type": "event",
"name": "Doctor appointment",
"notes": "Regular checkup with Dr. Smith",
"is_private": false,
"alarm_before_minutes": 5,
"is_all_day": false,
"location": {"place_id": "ChIJN1t_tDeuEmsRUsoyG83frY4",
"name": "Googleplex"
},
"periodicity_type": "interval",
"periodicity_dow": [ ],
"periodicity_interval": "monthly",
"start_date": "2025-12-05",
"end_date": "2025-12-05",
"start_hour": "14:00",
"end_hour": "15:00",
"hours": null,
"time_zone": "UTC",
"series_end_date": "2026-01-05",
"dosage": null,
"vital_sign_measurement_type": null,
"adl_type": null,
"assignee": {"id": 1404,
"full_name": "Whitney Littel Cliff Runolfsson",
"avatar_url": null,
"placeholder_avatar_data": {"initials": "FF",
"background_color": "#FF0000"
}
},
"vault_content_calendar_display": null,
"files": [{"id": 14,
"name": "pdf-document.pdf",
"size": 0,
"file_url": "http://minio:9000/caily-private/private_store/periodic_event_file/14/example-pdf20251205-82-iprh6g-14.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=minioadmin%2F20251205%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20251205T120722Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=d1b6a6d799f4fe1c882a6949d5181053d16f641c08f411868223921960f336f5"
}
]
}

List periodic events

Authorizations:

Bearer Token

query Parameters

circle_id required	integer
from_date required	string <date> Example: from_date=2025-01-01
to_date required	string <date> Example: to_date=2025-01-01 Max 3 months after from_date
time_zone required	string Enum: "Africa/Abidjan" "Africa/Accra" "Africa/Addis_Ababa" "Africa/Algiers" "Africa/Asmara" "Africa/Bamako" "Africa/Bangui" "Africa/Banjul" "Africa/Bissau" "Africa/Blantyre" "Africa/Brazzaville" "Africa/Bujumbura" "Africa/Cairo" "Africa/Casablanca" "Africa/Ceuta" "Africa/Conakry" "Africa/Dakar" "Africa/Dar_es_Salaam" "Africa/Djibouti" "Africa/Douala" "Africa/El_Aaiun" "Africa/Freetown" "Africa/Gaborone" "Africa/Harare" "Africa/Johannesburg" "Africa/Juba" "Africa/Kampala" "Africa/Khartoum" "Africa/Kigali" "Africa/Kinshasa" "Africa/Lagos" "Africa/Libreville" "Africa/Lome" "Africa/Luanda" "Africa/Lubumbashi" "Africa/Lusaka" "Africa/Malabo" "Africa/Maputo" "Africa/Maseru" "Africa/Mbabane" "Africa/Mogadishu" "Africa/Monrovia" "Africa/Nairobi" "Africa/Ndjamena" "Africa/Niamey" "Africa/Nouakchott" "Africa/Ouagadougou" "Africa/Porto-Novo" "Africa/Sao_Tome" "Africa/Timbuktu" "Africa/Tripoli" "Africa/Tunis" "Africa/Windhoek" "America/Adak" "America/Anchorage" "America/Anguilla" "America/Antigua" "America/Araguaina" "America/Argentina/Buenos_Aires" "America/Argentina/Catamarca" "America/Argentina/Cordoba" "America/Argentina/Jujuy" "America/Argentina/La_Rioja" "America/Argentina/Mendoza" "America/Argentina/Rio_Gallegos" "America/Argentina/Salta" "America/Argentina/San_Juan" "America/Argentina/San_Luis" "America/Argentina/Tucuman" "America/Argentina/Ushuaia" "America/Aruba" "America/Asuncion" "America/Atikokan" "America/Atka" "America/Bahia" "America/Bahia_Banderas" "America/Barbados" "America/Belem" "America/Belize" "America/Blanc-Sablon" "America/Boa_Vista" "America/Bogota" "America/Boise" "America/Cambridge_Bay" "America/Campo_Grande" "America/Cancun" "America/Caracas" "America/Cayenne" "America/Cayman" "America/Chicago" "America/Chihuahua" "America/Ciudad_Juarez" "America/Coral_Harbour" "America/Costa_Rica" "America/Creston" "America/Cuiaba" "America/Curacao" "America/Danmarkshavn" "America/Dawson" "America/Dawson_Creek" "America/Denver" "America/Detroit" "America/Dominica" "America/Edmonton" "America/Eirunepe" "America/El_Salvador" "America/Ensenada" "America/Fort_Nelson" "America/Fortaleza" "America/Glace_Bay" "America/Goose_Bay" "America/Grand_Turk" "America/Grenada" "America/Guadeloupe" "America/Guatemala" "America/Guayaquil" "America/Guyana" "America/Halifax" "America/Havana" "America/Hermosillo" "America/Indiana/Indianapolis" "America/Indiana/Knox" "America/Indiana/Marengo" "America/Indiana/Petersburg" "America/Indiana/Tell_City" "America/Indiana/Vevay" "America/Indiana/Vincennes" "America/Indiana/Winamac" "America/Inuvik" "America/Iqaluit" "America/Jamaica" "America/Juneau" "America/Kentucky/Louisville" "America/Kentucky/Monticello" "America/Kralendijk" "America/La_Paz" "America/Lima" "America/Los_Angeles" "America/Lower_Princes" "America/Maceio" "America/Managua" "America/Manaus" "America/Marigot" "America/Martinique" "America/Matamoros" "America/Mazatlan" "America/Menominee" "America/Merida" "America/Metlakatla" "America/Mexico_City" "America/Miquelon" "America/Moncton" "America/Monterrey" "America/Montevideo" "America/Montreal" "America/Montserrat" "America/Nassau" "America/New_York" "America/Nipigon" "America/Nome" "America/Noronha" "America/North_Dakota/Beulah" "America/North_Dakota/Center" "America/North_Dakota/New_Salem" "America/Nuuk" "America/Ojinaga" "America/Panama" "America/Pangnirtung" "America/Paramaribo" "America/Phoenix" "America/Port-au-Prince" "America/Port_of_Spain" "America/Porto_Acre" "America/Porto_Velho" "America/Puerto_Rico" "America/Punta_Arenas" "America/Rainy_River" "America/Rankin_Inlet" "America/Recife" "America/Regina" "America/Resolute" "America/Rio_Branco" "America/Santa_Isabel" "America/Santarem" "America/Santiago" "America/Santo_Domingo" "America/Sao_Paulo" "America/Scoresbysund" "America/Shiprock" "America/Sitka" "America/St_Barthelemy" "America/St_Johns" "America/St_Kitts" "America/St_Lucia" "America/St_Thomas" "America/St_Vincent" "America/Swift_Current" "America/Tegucigalpa" "America/Thule" "America/Thunder_Bay" "America/Tijuana" "America/Toronto" "America/Tortola" "America/Vancouver" "America/Virgin" "America/Whitehorse" "America/Winnipeg" "America/Yakutat" "America/Yellowknife" "Antarctica/Casey" "Antarctica/Davis" "Antarctica/DumontDUrville" "Antarctica/Macquarie" "Antarctica/Mawson" "Antarctica/McMurdo" "Antarctica/Palmer" "Antarctica/Rothera" "Antarctica/Syowa" "Antarctica/Troll" "Antarctica/Vostok" "Arctic/Longyearbyen" "Asia/Aden" "Asia/Almaty" "Asia/Amman" "Asia/Anadyr" "Asia/Aqtau" "Asia/Aqtobe" "Asia/Ashgabat" "Asia/Atyrau" "Asia/Baghdad" "Asia/Bahrain" "Asia/Baku" "Asia/Bangkok" "Asia/Barnaul" "Asia/Beirut" "Asia/Bishkek" "Asia/Brunei" "Asia/Chita" "Asia/Chongqing" "Asia/Colombo" "Asia/Damascus" "Asia/Dhaka" "Asia/Dili" "Asia/Dubai" "Asia/Dushanbe" "Asia/Famagusta" "Asia/Gaza" "Asia/Harbin" "Asia/Hebron" "Asia/Ho_Chi_Minh" "Asia/Hong_Kong" "Asia/Hovd" "Asia/Irkutsk" "Asia/Istanbul" "Asia/Jakarta" "Asia/Jayapura" "Asia/Jerusalem" "Asia/Kabul" "Asia/Kamchatka" "Asia/Karachi" "Asia/Kashgar" "Asia/Kathmandu" "Asia/Khandyga" "Asia/Kolkata" "Asia/Krasnoyarsk" "Asia/Kuala_Lumpur" "Asia/Kuching" "Asia/Kuwait" "Asia/Macau" "Asia/Magadan" "Asia/Makassar" "Asia/Manila" "Asia/Muscat" "Asia/Nicosia" "Asia/Novokuznetsk" "Asia/Novosibirsk" "Asia/Omsk" "Asia/Oral" "Asia/Phnom_Penh" "Asia/Pontianak" "Asia/Pyongyang" "Asia/Qatar" "Asia/Qostanay" "Asia/Qyzylorda" "Asia/Riyadh" "Asia/Sakhalin" "Asia/Samarkand" "Asia/Seoul" "Asia/Shanghai" "Asia/Singapore" "Asia/Srednekolymsk" "Asia/Taipei" "Asia/Tashkent" "Asia/Tbilisi" "Asia/Tehran" "Asia/Tel_Aviv" "Asia/Thimphu" "Asia/Tokyo" "Asia/Tomsk" "Asia/Ulaanbaatar" "Asia/Urumqi" "Asia/Ust-Nera" "Asia/Vientiane" "Asia/Vladivostok" "Asia/Yakutsk" "Asia/Yangon" "Asia/Yekaterinburg" "Asia/Yerevan" "Atlantic/Azores" "Atlantic/Bermuda" "Atlantic/Canary" "Atlantic/Cape_Verde" "Atlantic/Faroe" "Atlantic/Jan_Mayen" "Atlantic/Madeira" "Atlantic/Reykjavik" "Atlantic/South_Georgia" "Atlantic/St_Helena" "Atlantic/Stanley" "Australia/Adelaide" "Australia/Brisbane" "Australia/Broken_Hill" "Australia/Canberra" "Australia/Currie" "Australia/Darwin" "Australia/Eucla" "Australia/Hobart" "Australia/Lindeman" "Australia/Lord_Howe" "Australia/Melbourne" "Australia/Perth" "Australia/Sydney" "Australia/Yancowinna" "Etc/GMT" "Etc/GMT+0" "Etc/GMT+1" "Etc/GMT+10" "Etc/GMT+11" "Etc/GMT+12" "Etc/GMT+2" "Etc/GMT+3" "Etc/GMT+4" "Etc/GMT+5" "Etc/GMT+6" "Etc/GMT+7" "Etc/GMT+8" "Etc/GMT+9" "Etc/GMT-0" "Etc/GMT-1" "Etc/GMT-10" "Etc/GMT-11" "Etc/GMT-12" "Etc/GMT-13" "Etc/GMT-14" "Etc/GMT-2" "Etc/GMT-3" "Etc/GMT-4" "Etc/GMT-5" "Etc/GMT-6" "Etc/GMT-7" "Etc/GMT-8" "Etc/GMT-9" "Etc/GMT0" "Etc/Greenwich" "Etc/UCT" "Etc/UTC" "Etc/Universal" "Etc/Zulu" "Europe/Amsterdam" "Europe/Andorra" "Europe/Astrakhan" "Europe/Athens" "Europe/Belfast" "Europe/Belgrade" "Europe/Berlin" "Europe/Bratislava" "Europe/Brussels" "Europe/Bucharest" "Europe/Budapest" "Europe/Busingen" "Europe/Chisinau" "Europe/Copenhagen" "Europe/Dublin" "Europe/Gibraltar" "Europe/Guernsey" "Europe/Helsinki" "Europe/Isle_of_Man" "Europe/Istanbul" "Europe/Jersey" "Europe/Kaliningrad" "Europe/Kirov" "Europe/Kyiv" "Europe/Lisbon" "Europe/Ljubljana" "Europe/London" "Europe/Luxembourg" "Europe/Madrid" "Europe/Malta" "Europe/Mariehamn" "Europe/Minsk" "Europe/Monaco" "Europe/Moscow" "Europe/Nicosia" "Europe/Oslo" "Europe/Paris" "Europe/Podgorica" "Europe/Prague" "Europe/Riga" "Europe/Rome" "Europe/Samara" "Europe/San_Marino" "Europe/Sarajevo" "Europe/Saratov" "Europe/Simferopol" "Europe/Skopje" "Europe/Sofia" "Europe/Stockholm" "Europe/Tallinn" "Europe/Tirane" "Europe/Tiraspol" "Europe/Ulyanovsk" "Europe/Vaduz" "Europe/Vatican" "Europe/Vienna" "Europe/Vilnius" "Europe/Volgograd" "Europe/Warsaw" "Europe/Zagreb" "Europe/Zurich" "Factory" "GMT" "Indian/Antananarivo" "Indian/Chagos" "Indian/Christmas" "Indian/Cocos" "Indian/Comoro" "Indian/Kerguelen" "Indian/Mahe" "Indian/Maldives" "Indian/Mauritius" "Indian/Mayotte" "Indian/Reunion" "Pacific/Apia" "Pacific/Auckland" "Pacific/Bougainville" "Pacific/Chatham" "Pacific/Chuuk" "Pacific/Easter" "Pacific/Efate" "Pacific/Fakaofo" "Pacific/Fiji" "Pacific/Funafuti" "Pacific/Galapagos" "Pacific/Gambier" "Pacific/Guadalcanal" "Pacific/Guam" "Pacific/Honolulu" "Pacific/Johnston" "Pacific/Kanton" "Pacific/Kiritimati" "Pacific/Kosrae" "Pacific/Kwajalein" "Pacific/Majuro" "Pacific/Marquesas" "Pacific/Midway" "Pacific/Nauru" "Pacific/Niue" "Pacific/Norfolk" "Pacific/Noumea" "Pacific/Pago_Pago" "Pacific/Palau" "Pacific/Pitcairn" "Pacific/Pohnpei" "Pacific/Port_Moresby" "Pacific/Rarotonga" "Pacific/Saipan" "Pacific/Samoa" "Pacific/Tahiti" "Pacific/Tarawa" "Pacific/Tongatapu" "Pacific/Wake" "Pacific/Wallis" "Pacific/Yap" "UTC"
	object

Responses

Response samples

200
401
403
404
422

Content type

application/json

{"events": [{"id": 151,
"created_at": "2025-12-05T12:07:23.971247Z",
"event_type": "event",
"name": "itaque",
"vital_sign_measurement_type": null,
"adl_type": null,
"location": null,
"is_private": false,
"is_all_day": false,
"has_note": true,
"has_files": false,
"assignee": {"id": 1456,
"full_name": "Shanta Herzog MD The Hon. Deena Barton",
"avatar_url": null,
"placeholder_avatar_data": {"initials": "FF",
"background_color": "#FF0000"
}
}
}
],
"calendar_entries": [{"id": 164,
"starts_at": "2025-01-01T00:00:00.000000Z",
"ends_at": "2025-01-01T01:00:00.000000Z",
"periodic_event_id": 151,
"completed": false,
"location": null,
"has_notes": false,
"assignee_avatar_url": "http://minio:9000/caily-private/private_store/index-id.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=minioadmin%2F20251205%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20251205T120724Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=d1693883e352519f3a92898d20145548b334c22a873e6138006552756ca57be1",
"assignee_placeholder_avatar_data": {"initials": "FF",
"background_color": "#FF0000"
}
},
{"id": 165,
"starts_at": "2025-01-02T00:00:00.000000Z",
"ends_at": "2025-01-02T01:00:00.000000Z",
"periodic_event_id": 151,
"completed": false,
"location": null,
"has_notes": false,
"assignee_avatar_url": null,
"assignee_placeholder_avatar_data": null
},
{"id": 166,
"starts_at": "2025-01-03T00:00:00.000000Z",
"ends_at": "2025-01-03T01:00:00.000000Z",
"periodic_event_id": 151,
"completed": false,
"location": null,
"has_notes": false,
"assignee_avatar_url": null,
"assignee_placeholder_avatar_data": null
}
]
}

Delete periodic event

Authorizations:

Bearer Token

path Parameters

id

required

integer

query Parameters

event_delete_type required	string : `all_events` `this_and_future_events` `future_events`
calendar_entry_id	integer required if event_delete_type is this_and_future_events

Responses

Response samples

401
403
404
422

Content type

application/json

{"error": {"code": "unauthorized",
"details": [{"key": "_base",
"message": "Session has expired"
}
]
}
}

Show periodic event

Authorizations:

Bearer Token

path Parameters

id

required

integer

Responses

Response samples

200
401
403
404
422

Content type

application/json

{"id": 159,
"created_at": "2025-12-05T12:07:24.394729Z",
"event_type": "event",
"name": "quia",
"notes": "Perferendis recusandae sunt et.",
"is_private": false,
"alarm_before_minutes": null,
"is_all_day": false,
"location": null,
"periodicity_type": "interval",
"periodicity_dow": null,
"periodicity_interval": "daily",
"start_date": "2025-12-05",
"end_date": "2025-12-05",
"start_hour": "10:00",
"end_hour": "11:00",
"hours": null,
"time_zone": "UTC",
"series_end_date": null,
"dosage": null,
"vital_sign_measurement_type": null,
"adl_type": null,
"assignee": null,
"vault_content_calendar_display": null,
"files": [ ]
}

Update periodic event

Authorizations:

Bearer Token

path Parameters

id

required

integer

Request Body schema: application/json

event_update_type required	string Enum: "all_events" "this_and_future_events" "future_events" when periodicity_type is one_time only 'all_events' is accepted
force	boolean force update, required events are rewritten, should be confirmed by a user
name required	string
notes required	string or null
required	object or null
is_private required	boolean can be changed only by creator
alarm_before_minutes required	integer or null Alarm before minutes, max 1440
periodicity_type required	string Enum: "one_time" "interval" "day_of_week"
periodicity_interval	string Enum: "daily" "weekly" "every_two_weeks" "monthly" "yearly" required when periodicity_type is interval
periodicity_dow	Array of integers Items Enum: 0 1 2 3 4 5 6
start_date required	string or null <date> Local start date of the series, max 5 years in the past
end_date required	string or null <date> Local end date of the series
series_end_date required	string or null <date> Local end date of the series, null for endless events, max 10 years after start_date
start_hour required	string or null <(?-mix:^(?:[01]\d\|2[0-3]):(?:[0-5]{1}\d{1})$)> Local start hour of the event, null for all day events
end_hour required	string or null <(?-mix:^(?:[01]\d\|2[0-3]):(?:[0-5]{1}\d{1})$)> Local end hour of the event, max 24 hours after start_hour, null for all day events
is_all_day required	boolean
assignee_id required	integer or null Only current user is allowed for private events
calendar_entry_id	integer or null used by this and future entries update type

Responses

Request samples

Payload

Content type

application/json

{"event_update_type": "all_events",
"force": true,
"name": "string",
"notes": "string",
"location": {"place_id": "string",
"name": "string"
},
"is_private": true,
"alarm_before_minutes": 0,
"periodicity_type": "one_time",
"periodicity_interval": "daily",
"periodicity_dow": [0
],
"start_date": "2019-08-24",
"end_date": "2019-08-24",
"series_end_date": "2019-08-24",
"start_hour": "string",
"end_hour": "string",
"is_all_day": true,
"assignee_id": 0,
"calendar_entry_id": 0
}

Response samples

200
401
403
404
422

Content type

application/json

{"id": 165,
"created_at": "2025-12-05T12:07:24.664943Z",
"event_type": "event",
"name": "Updated Event",
"notes": "Updated notes",
"is_private": false,
"alarm_before_minutes": 15,
"is_all_day": false,
"location": {"place_id": "123",
"name": "Updated Location"
},
"periodicity_type": "day_of_week",
"periodicity_dow": [1
],
"periodicity_interval": "daily",
"start_date": "2025-12-05",
"end_date": "2025-12-05",
"start_hour": "10:00",
"end_hour": "11:00",
"hours": null,
"time_zone": "UTC",
"series_end_date": null,
"dosage": null,
"vital_sign_measurement_type": null,
"adl_type": null,
"assignee": null,
"vault_content_calendar_display": null,
"files": [ ]
}

List periodic event history

Authorizations:

Bearer Token

path Parameters

id

required

integer

query Parameters

from_date required	string <date> Example: from_date=2025-01-01
to_date required	string <date> Example: to_date=2025-01-01 Max 3 months after from_date
time_zone required	string Enum: "Africa/Abidjan" "Africa/Accra" "Africa/Addis_Ababa" "Africa/Algiers" "Africa/Asmara" "Africa/Bamako" "Africa/Bangui" "Africa/Banjul" "Africa/Bissau" "Africa/Blantyre" "Africa/Brazzaville" "Africa/Bujumbura" "Africa/Cairo" "Africa/Casablanca" "Africa/Ceuta" "Africa/Conakry" "Africa/Dakar" "Africa/Dar_es_Salaam" "Africa/Djibouti" "Africa/Douala" "Africa/El_Aaiun" "Africa/Freetown" "Africa/Gaborone" "Africa/Harare" "Africa/Johannesburg" "Africa/Juba" "Africa/Kampala" "Africa/Khartoum" "Africa/Kigali" "Africa/Kinshasa" "Africa/Lagos" "Africa/Libreville" "Africa/Lome" "Africa/Luanda" "Africa/Lubumbashi" "Africa/Lusaka" "Africa/Malabo" "Africa/Maputo" "Africa/Maseru" "Africa/Mbabane" "Africa/Mogadishu" "Africa/Monrovia" "Africa/Nairobi" "Africa/Ndjamena" "Africa/Niamey" "Africa/Nouakchott" "Africa/Ouagadougou" "Africa/Porto-Novo" "Africa/Sao_Tome" "Africa/Timbuktu" "Africa/Tripoli" "Africa/Tunis" "Africa/Windhoek" "America/Adak" "America/Anchorage" "America/Anguilla" "America/Antigua" "America/Araguaina" "America/Argentina/Buenos_Aires" "America/Argentina/Catamarca" "America/Argentina/Cordoba" "America/Argentina/Jujuy" "America/Argentina/La_Rioja" "America/Argentina/Mendoza" "America/Argentina/Rio_Gallegos" "America/Argentina/Salta" "America/Argentina/San_Juan" "America/Argentina/San_Luis" "America/Argentina/Tucuman" "America/Argentina/Ushuaia" "America/Aruba" "America/Asuncion" "America/Atikokan" "America/Atka" "America/Bahia" "America/Bahia_Banderas" "America/Barbados" "America/Belem" "America/Belize" "America/Blanc-Sablon" "America/Boa_Vista" "America/Bogota" "America/Boise" "America/Cambridge_Bay" "America/Campo_Grande" "America/Cancun" "America/Caracas" "America/Cayenne" "America/Cayman" "America/Chicago" "America/Chihuahua" "America/Ciudad_Juarez" "America/Coral_Harbour" "America/Costa_Rica" "America/Creston" "America/Cuiaba" "America/Curacao" "America/Danmarkshavn" "America/Dawson" "America/Dawson_Creek" "America/Denver" "America/Detroit" "America/Dominica" "America/Edmonton" "America/Eirunepe" "America/El_Salvador" "America/Ensenada" "America/Fort_Nelson" "America/Fortaleza" "America/Glace_Bay" "America/Goose_Bay" "America/Grand_Turk" "America/Grenada" "America/Guadeloupe" "America/Guatemala" "America/Guayaquil" "America/Guyana" "America/Halifax" "America/Havana" "America/Hermosillo" "America/Indiana/Indianapolis" "America/Indiana/Knox" "America/Indiana/Marengo" "America/Indiana/Petersburg" "America/Indiana/Tell_City" "America/Indiana/Vevay" "America/Indiana/Vincennes" "America/Indiana/Winamac" "America/Inuvik" "America/Iqaluit" "America/Jamaica" "America/Juneau" "America/Kentucky/Louisville" "America/Kentucky/Monticello" "America/Kralendijk" "America/La_Paz" "America/Lima" "America/Los_Angeles" "America/Lower_Princes" "America/Maceio" "America/Managua" "America/Manaus" "America/Marigot" "America/Martinique" "America/Matamoros" "America/Mazatlan" "America/Menominee" "America/Merida" "America/Metlakatla" "America/Mexico_City" "America/Miquelon" "America/Moncton" "America/Monterrey" "America/Montevideo" "America/Montreal" "America/Montserrat" "America/Nassau" "America/New_York" "America/Nipigon" "America/Nome" "America/Noronha" "America/North_Dakota/Beulah" "America/North_Dakota/Center" "America/North_Dakota/New_Salem" "America/Nuuk" "America/Ojinaga" "America/Panama" "America/Pangnirtung" "America/Paramaribo" "America/Phoenix" "America/Port-au-Prince" "America/Port_of_Spain" "America/Porto_Acre" "America/Porto_Velho" "America/Puerto_Rico" "America/Punta_Arenas" "America/Rainy_River" "America/Rankin_Inlet" "America/Recife" "America/Regina" "America/Resolute" "America/Rio_Branco" "America/Santa_Isabel" "America/Santarem" "America/Santiago" "America/Santo_Domingo" "America/Sao_Paulo" "America/Scoresbysund" "America/Shiprock" "America/Sitka" "America/St_Barthelemy" "America/St_Johns" "America/St_Kitts" "America/St_Lucia" "America/St_Thomas" "America/St_Vincent" "America/Swift_Current" "America/Tegucigalpa" "America/Thule" "America/Thunder_Bay" "America/Tijuana" "America/Toronto" "America/Tortola" "America/Vancouver" "America/Virgin" "America/Whitehorse" "America/Winnipeg" "America/Yakutat" "America/Yellowknife" "Antarctica/Casey" "Antarctica/Davis" "Antarctica/DumontDUrville" "Antarctica/Macquarie" "Antarctica/Mawson" "Antarctica/McMurdo" "Antarctica/Palmer" "Antarctica/Rothera" "Antarctica/Syowa" "Antarctica/Troll" "Antarctica/Vostok" "Arctic/Longyearbyen" "Asia/Aden" "Asia/Almaty" "Asia/Amman" "Asia/Anadyr" "Asia/Aqtau" "Asia/Aqtobe" "Asia/Ashgabat" "Asia/Atyrau" "Asia/Baghdad" "Asia/Bahrain" "Asia/Baku" "Asia/Bangkok" "Asia/Barnaul" "Asia/Beirut" "Asia/Bishkek" "Asia/Brunei" "Asia/Chita" "Asia/Chongqing" "Asia/Colombo" "Asia/Damascus" "Asia/Dhaka" "Asia/Dili" "Asia/Dubai" "Asia/Dushanbe" "Asia/Famagusta" "Asia/Gaza" "Asia/Harbin" "Asia/Hebron" "Asia/Ho_Chi_Minh" "Asia/Hong_Kong" "Asia/Hovd" "Asia/Irkutsk" "Asia/Istanbul" "Asia/Jakarta" "Asia/Jayapura" "Asia/Jerusalem" "Asia/Kabul" "Asia/Kamchatka" "Asia/Karachi" "Asia/Kashgar" "Asia/Kathmandu" "Asia/Khandyga" "Asia/Kolkata" "Asia/Krasnoyarsk" "Asia/Kuala_Lumpur" "Asia/Kuching" "Asia/Kuwait" "Asia/Macau" "Asia/Magadan" "Asia/Makassar" "Asia/Manila" "Asia/Muscat" "Asia/Nicosia" "Asia/Novokuznetsk" "Asia/Novosibirsk" "Asia/Omsk" "Asia/Oral" "Asia/Phnom_Penh" "Asia/Pontianak" "Asia/Pyongyang" "Asia/Qatar" "Asia/Qostanay" "Asia/Qyzylorda" "Asia/Riyadh" "Asia/Sakhalin" "Asia/Samarkand" "Asia/Seoul" "Asia/Shanghai" "Asia/Singapore" "Asia/Srednekolymsk" "Asia/Taipei" "Asia/Tashkent" "Asia/Tbilisi" "Asia/Tehran" "Asia/Tel_Aviv" "Asia/Thimphu" "Asia/Tokyo" "Asia/Tomsk" "Asia/Ulaanbaatar" "Asia/Urumqi" "Asia/Ust-Nera" "Asia/Vientiane" "Asia/Vladivostok" "Asia/Yakutsk" "Asia/Yangon" "Asia/Yekaterinburg" "Asia/Yerevan" "Atlantic/Azores" "Atlantic/Bermuda" "Atlantic/Canary" "Atlantic/Cape_Verde" "Atlantic/Faroe" "Atlantic/Jan_Mayen" "Atlantic/Madeira" "Atlantic/Reykjavik" "Atlantic/South_Georgia" "Atlantic/St_Helena" "Atlantic/Stanley" "Australia/Adelaide" "Australia/Brisbane" "Australia/Broken_Hill" "Australia/Canberra" "Australia/Currie" "Australia/Darwin" "Australia/Eucla" "Australia/Hobart" "Australia/Lindeman" "Australia/Lord_Howe" "Australia/Melbourne" "Australia/Perth" "Australia/Sydney" "Australia/Yancowinna" "Etc/GMT" "Etc/GMT+0" "Etc/GMT+1" "Etc/GMT+10" "Etc/GMT+11" "Etc/GMT+12" "Etc/GMT+2" "Etc/GMT+3" "Etc/GMT+4" "Etc/GMT+5" "Etc/GMT+6" "Etc/GMT+7" "Etc/GMT+8" "Etc/GMT+9" "Etc/GMT-0" "Etc/GMT-1" "Etc/GMT-10" "Etc/GMT-11" "Etc/GMT-12" "Etc/GMT-13" "Etc/GMT-14" "Etc/GMT-2" "Etc/GMT-3" "Etc/GMT-4" "Etc/GMT-5" "Etc/GMT-6" "Etc/GMT-7" "Etc/GMT-8" "Etc/GMT-9" "Etc/GMT0" "Etc/Greenwich" "Etc/UCT" "Etc/UTC" "Etc/Universal" "Etc/Zulu" "Europe/Amsterdam" "Europe/Andorra" "Europe/Astrakhan" "Europe/Athens" "Europe/Belfast" "Europe/Belgrade" "Europe/Berlin" "Europe/Bratislava" "Europe/Brussels" "Europe/Bucharest" "Europe/Budapest" "Europe/Busingen" "Europe/Chisinau" "Europe/Copenhagen" "Europe/Dublin" "Europe/Gibraltar" "Europe/Guernsey" "Europe/Helsinki" "Europe/Isle_of_Man" "Europe/Istanbul" "Europe/Jersey" "Europe/Kaliningrad" "Europe/Kirov" "Europe/Kyiv" "Europe/Lisbon" "Europe/Ljubljana" "Europe/London" "Europe/Luxembourg" "Europe/Madrid" "Europe/Malta" "Europe/Mariehamn" "Europe/Minsk" "Europe/Monaco" "Europe/Moscow" "Europe/Nicosia" "Europe/Oslo" "Europe/Paris" "Europe/Podgorica" "Europe/Prague" "Europe/Riga" "Europe/Rome" "Europe/Samara" "Europe/San_Marino" "Europe/Sarajevo" "Europe/Saratov" "Europe/Simferopol" "Europe/Skopje" "Europe/Sofia" "Europe/Stockholm" "Europe/Tallinn" "Europe/Tirane" "Europe/Tiraspol" "Europe/Ulyanovsk" "Europe/Vaduz" "Europe/Vatican" "Europe/Vienna" "Europe/Vilnius" "Europe/Volgograd" "Europe/Warsaw" "Europe/Zagreb" "Europe/Zurich" "Factory" "GMT" "Indian/Antananarivo" "Indian/Chagos" "Indian/Christmas" "Indian/Cocos" "Indian/Comoro" "Indian/Kerguelen" "Indian/Mahe" "Indian/Maldives" "Indian/Mauritius" "Indian/Mayotte" "Indian/Reunion" "Pacific/Apia" "Pacific/Auckland" "Pacific/Bougainville" "Pacific/Chatham" "Pacific/Chuuk" "Pacific/Easter" "Pacific/Efate" "Pacific/Fakaofo" "Pacific/Fiji" "Pacific/Funafuti" "Pacific/Galapagos" "Pacific/Gambier" "Pacific/Guadalcanal" "Pacific/Guam" "Pacific/Honolulu" "Pacific/Johnston" "Pacific/Kanton" "Pacific/Kiritimati" "Pacific/Kosrae" "Pacific/Kwajalein" "Pacific/Majuro" "Pacific/Marquesas" "Pacific/Midway" "Pacific/Nauru" "Pacific/Niue" "Pacific/Norfolk" "Pacific/Noumea" "Pacific/Pago_Pago" "Pacific/Palau" "Pacific/Pitcairn" "Pacific/Pohnpei" "Pacific/Port_Moresby" "Pacific/Rarotonga" "Pacific/Saipan" "Pacific/Samoa" "Pacific/Tahiti" "Pacific/Tarawa" "Pacific/Tongatapu" "Pacific/Wake" "Pacific/Wallis" "Pacific/Yap" "UTC"

Responses

Response samples

200
401
403
404
422

Content type

application/json

[{"calendar_entry_id": 148,
"starts_at": "2025-01-03T00:00:00.000000Z",
"ends_at": "2025-01-03T01:00:00.000000Z",
"completed": false
},
{"calendar_entry_id": 147,
"starts_at": "2025-01-02T00:00:00.000000Z",
"ends_at": "2025-01-02T01:00:00.000000Z",
"completed": false
},
{"calendar_entry_id": 146,
"starts_at": "2025-01-01T00:00:00.000000Z",
"ends_at": "2025-01-01T01:00:00.000000Z",
"completed": false
}
]

[COMMON] Profiles

Cancel email change

Authorizations:

Bearer Token

Responses

Response samples

401

Content type

application/json

{"error": {"code": "unauthorized",
"details": [{"key": "_base",
"message": "Session has expired"
}
]
}
}

Get current user's circle invitations

Authorizations:

Bearer Token

Responses

Response samples

200
401

Content type

application/json

[{"id": 43,
"circle_id": 806,
"circle_name": "Leatha Metz",
"members_count": 4,
"avatar_url": "http://minio:9000/caily-private/private_store/index-id.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=minioadmin%2F20251205%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20251205T120725Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=d011e1c1b83f6ed7f40f98c81e53df5065cfc8b3cfcb23a2f3516a684b8d114a",
"placeholder_avatar_data": {"initials": "FF",
"background_color": "#FF0000"
},
"circle_role": "patient"
},
{"id": 45,
"circle_id": 807,
"circle_name": "Chance Koss",
"members_count": 1,
"avatar_url": "http://minio:9000/caily-private/private_store/index-id.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=minioadmin%2F20251205%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20251205T120725Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=d011e1c1b83f6ed7f40f98c81e53df5065cfc8b3cfcb23a2f3516a684b8d114a",
"placeholder_avatar_data": {"initials": "FF",
"background_color": "#FF0000"
},
"circle_role": "patient"
}
]

Get current user's circle requests

Authorizations:

Bearer Token

Responses

Response samples

200
401

Content type

application/json

[{"id": 36,
"circle_id": 810,
"circle_name": "Mike Marquardt",
"members_count": 0,
"avatar_url": null,
"placeholder_avatar_data": {"initials": "JD",
"background_color": "#000000"
}
},
{"id": 37,
"circle_id": 811,
"circle_name": "Demetra Ferry",
"members_count": 0,
"avatar_url": null,
"placeholder_avatar_data": {"initials": "JD",
"background_color": "#000000"
}
},
{"id": 38,
"circle_id": 812,
"circle_name": "Dick Walsh I",
"members_count": 0,
"avatar_url": null,
"placeholder_avatar_data": {"initials": "JD",
"background_color": "#000000"
}
}
]

Get current user's circles

Authorizations:

Bearer Token

Responses

Response samples

200
401

Content type

application/json

[{"id": 816,
"name": "Jena Adams",
"members_count": 1,
"avatar_url": null,
"last_3_users_data": [ ],
"placeholder_avatar_data": {"initials": "JD",
"background_color": "#000000"
}
}
]

Delete account

Authorizations:

Bearer Token

Responses

Show current user's profile

Authorizations:

Bearer Token

header Parameters

time-zone	string
accept-language	string

Responses

Response samples

200
401

Content type

application/json

Example

when everything is ok

{"id": 1580,
"first_name": "Darci Mills",
"last_name": "Leigha Johnston",
"email": "user1578@example.com",
"phone_number": null,
"birthday": "1963-12-18",
"avatar_url": null,
"unit_system": "imperial",
"confirmed": false,
"onboarding_completed": false,
"has_password": true,
"is_biometrics_enabled": false,
"time_zone": "UTC",
"active_circle_id": null,
"locale": "en",
"placeholder_avatar_data": {"initials": "FF",
"background_color": "#FF0000"
},
"free_trial_available": true,
"can_manage_subscription": false,
"changed_email": null
}

Update current user's profile

Authorizations:

Bearer Token

Request Body schema: multipart/form-data

password	string min. size: 8, capital letter, letter, digit, special character required
current_password	string can be used as mfa to change password
pin	string 4 digits, update works only for initial setup; can be used as mfa to change password
first_name	string
last_name	string or null
phone_number	string or null with code, for example '+1 555 123 4567'
birthday	date or null Used in initial survey
avatar	string or null <binary>
unit_system	string Enum: "metric" "imperial"
is_biometrics_enabled	boolean
active_circle_id	integer or null
time_zone	string Enum: "Africa/Abidjan" "Africa/Accra" "Africa/Addis_Ababa" "Africa/Algiers" "Africa/Asmara" "Africa/Bamako" "Africa/Bangui" "Africa/Banjul" "Africa/Bissau" "Africa/Blantyre" "Africa/Brazzaville" "Africa/Bujumbura" "Africa/Cairo" "Africa/Casablanca" "Africa/Ceuta" "Africa/Conakry" "Africa/Dakar" "Africa/Dar_es_Salaam" "Africa/Djibouti" "Africa/Douala" "Africa/El_Aaiun" "Africa/Freetown" "Africa/Gaborone" "Africa/Harare" "Africa/Johannesburg" "Africa/Juba" "Africa/Kampala" "Africa/Khartoum" "Africa/Kigali" "Africa/Kinshasa" "Africa/Lagos" "Africa/Libreville" "Africa/Lome" "Africa/Luanda" "Africa/Lubumbashi" "Africa/Lusaka" "Africa/Malabo" "Africa/Maputo" "Africa/Maseru" "Africa/Mbabane" "Africa/Mogadishu" "Africa/Monrovia" "Africa/Nairobi" "Africa/Ndjamena" "Africa/Niamey" "Africa/Nouakchott" "Africa/Ouagadougou" "Africa/Porto-Novo" "Africa/Sao_Tome" "Africa/Timbuktu" "Africa/Tripoli" "Africa/Tunis" "Africa/Windhoek" "America/Adak" "America/Anchorage" "America/Anguilla" "America/Antigua" "America/Araguaina" "America/Argentina/Buenos_Aires" "America/Argentina/Catamarca" "America/Argentina/Cordoba" "America/Argentina/Jujuy" "America/Argentina/La_Rioja" "America/Argentina/Mendoza" "America/Argentina/Rio_Gallegos" "America/Argentina/Salta" "America/Argentina/San_Juan" "America/Argentina/San_Luis" "America/Argentina/Tucuman" "America/Argentina/Ushuaia" "America/Aruba" "America/Asuncion" "America/Atikokan" "America/Atka" "America/Bahia" "America/Bahia_Banderas" "America/Barbados" "America/Belem" "America/Belize" "America/Blanc-Sablon" "America/Boa_Vista" "America/Bogota" "America/Boise" "America/Cambridge_Bay" "America/Campo_Grande" "America/Cancun" "America/Caracas" "America/Cayenne" "America/Cayman" "America/Chicago" "America/Chihuahua" "America/Ciudad_Juarez" "America/Coral_Harbour" "America/Costa_Rica" "America/Creston" "America/Cuiaba" "America/Curacao" "America/Danmarkshavn" "America/Dawson" "America/Dawson_Creek" "America/Denver" "America/Detroit" "America/Dominica" "America/Edmonton" "America/Eirunepe" "America/El_Salvador" "America/Ensenada" "America/Fort_Nelson" "America/Fortaleza" "America/Glace_Bay" "America/Goose_Bay" "America/Grand_Turk" "America/Grenada" "America/Guadeloupe" "America/Guatemala" "America/Guayaquil" "America/Guyana" "America/Halifax" "America/Havana" "America/Hermosillo" "America/Indiana/Indianapolis" "America/Indiana/Knox" "America/Indiana/Marengo" "America/Indiana/Petersburg" "America/Indiana/Tell_City" "America/Indiana/Vevay" "America/Indiana/Vincennes" "America/Indiana/Winamac" "America/Inuvik" "America/Iqaluit" "America/Jamaica" "America/Juneau" "America/Kentucky/Louisville" "America/Kentucky/Monticello" "America/Kralendijk" "America/La_Paz" "America/Lima" "America/Los_Angeles" "America/Lower_Princes" "America/Maceio" "America/Managua" "America/Manaus" "America/Marigot" "America/Martinique" "America/Matamoros" "America/Mazatlan" "America/Menominee" "America/Merida" "America/Metlakatla" "America/Mexico_City" "America/Miquelon" "America/Moncton" "America/Monterrey" "America/Montevideo" "America/Montreal" "America/Montserrat" "America/Nassau" "America/New_York" "America/Nipigon" "America/Nome" "America/Noronha" "America/North_Dakota/Beulah" "America/North_Dakota/Center" "America/North_Dakota/New_Salem" "America/Nuuk" "America/Ojinaga" "America/Panama" "America/Pangnirtung" "America/Paramaribo" "America/Phoenix" "America/Port-au-Prince" "America/Port_of_Spain" "America/Porto_Acre" "America/Porto_Velho" "America/Puerto_Rico" "America/Punta_Arenas" "America/Rainy_River" "America/Rankin_Inlet" "America/Recife" "America/Regina" "America/Resolute" "America/Rio_Branco" "America/Santa_Isabel" "America/Santarem" "America/Santiago" "America/Santo_Domingo" "America/Sao_Paulo" "America/Scoresbysund" "America/Shiprock" "America/Sitka" "America/St_Barthelemy" "America/St_Johns" "America/St_Kitts" "America/St_Lucia" "America/St_Thomas" "America/St_Vincent" "America/Swift_Current" "America/Tegucigalpa" "America/Thule" "America/Thunder_Bay" "America/Tijuana" "America/Toronto" "America/Tortola" "America/Vancouver" "America/Virgin" "America/Whitehorse" "America/Winnipeg" "America/Yakutat" "America/Yellowknife" "Antarctica/Casey" "Antarctica/Davis" "Antarctica/DumontDUrville" "Antarctica/Macquarie" "Antarctica/Mawson" "Antarctica/McMurdo" "Antarctica/Palmer" "Antarctica/Rothera" "Antarctica/Syowa" "Antarctica/Troll" "Antarctica/Vostok" "Arctic/Longyearbyen" "Asia/Aden" "Asia/Almaty" "Asia/Amman" "Asia/Anadyr" "Asia/Aqtau" "Asia/Aqtobe" "Asia/Ashgabat" "Asia/Atyrau" "Asia/Baghdad" "Asia/Bahrain" "Asia/Baku" "Asia/Bangkok" "Asia/Barnaul" "Asia/Beirut" "Asia/Bishkek" "Asia/Brunei" "Asia/Chita" "Asia/Chongqing" "Asia/Colombo" "Asia/Damascus" "Asia/Dhaka" "Asia/Dili" "Asia/Dubai" "Asia/Dushanbe" "Asia/Famagusta" "Asia/Gaza" "Asia/Harbin" "Asia/Hebron" "Asia/Ho_Chi_Minh" "Asia/Hong_Kong" "Asia/Hovd" "Asia/Irkutsk" "Asia/Istanbul" "Asia/Jakarta" "Asia/Jayapura" "Asia/Jerusalem" "Asia/Kabul" "Asia/Kamchatka" "Asia/Karachi" "Asia/Kashgar" "Asia/Kathmandu" "Asia/Khandyga" "Asia/Kolkata" "Asia/Krasnoyarsk" "Asia/Kuala_Lumpur" "Asia/Kuching" "Asia/Kuwait" "Asia/Macau" "Asia/Magadan" "Asia/Makassar" "Asia/Manila" "Asia/Muscat" "Asia/Nicosia" "Asia/Novokuznetsk" "Asia/Novosibirsk" "Asia/Omsk" "Asia/Oral" "Asia/Phnom_Penh" "Asia/Pontianak" "Asia/Pyongyang" "Asia/Qatar" "Asia/Qostanay" "Asia/Qyzylorda" "Asia/Riyadh" "Asia/Sakhalin" "Asia/Samarkand" "Asia/Seoul" "Asia/Shanghai" "Asia/Singapore" "Asia/Srednekolymsk" "Asia/Taipei" "Asia/Tashkent" "Asia/Tbilisi" "Asia/Tehran" "Asia/Tel_Aviv" "Asia/Thimphu" "Asia/Tokyo" "Asia/Tomsk" "Asia/Ulaanbaatar" "Asia/Urumqi" "Asia/Ust-Nera" "Asia/Vientiane" "Asia/Vladivostok" "Asia/Yakutsk" "Asia/Yangon" "Asia/Yekaterinburg" "Asia/Yerevan" "Atlantic/Azores" "Atlantic/Bermuda" "Atlantic/Canary" "Atlantic/Cape_Verde" "Atlantic/Faroe" "Atlantic/Jan_Mayen" "Atlantic/Madeira" "Atlantic/Reykjavik" "Atlantic/South_Georgia" "Atlantic/St_Helena" "Atlantic/Stanley" "Australia/Adelaide" "Australia/Brisbane" "Australia/Broken_Hill" "Australia/Canberra" "Australia/Currie" "Australia/Darwin" "Australia/Eucla" "Australia/Hobart" "Australia/Lindeman" "Australia/Lord_Howe" "Australia/Melbourne" "Australia/Perth" "Australia/Sydney" "Australia/Yancowinna" "Etc/GMT" "Etc/GMT+0" "Etc/GMT+1" "Etc/GMT+10" "Etc/GMT+11" "Etc/GMT+12" "Etc/GMT+2" "Etc/GMT+3" "Etc/GMT+4" "Etc/GMT+5" "Etc/GMT+6" "Etc/GMT+7" "Etc/GMT+8" "Etc/GMT+9" "Etc/GMT-0" "Etc/GMT-1" "Etc/GMT-10" "Etc/GMT-11" "Etc/GMT-12" "Etc/GMT-13" "Etc/GMT-14" "Etc/GMT-2" "Etc/GMT-3" "Etc/GMT-4" "Etc/GMT-5" "Etc/GMT-6" "Etc/GMT-7" "Etc/GMT-8" "Etc/GMT-9" "Etc/GMT0" "Etc/Greenwich" "Etc/UCT" "Etc/UTC" "Etc/Universal" "Etc/Zulu" "Europe/Amsterdam" "Europe/Andorra" "Europe/Astrakhan" "Europe/Athens" "Europe/Belfast" "Europe/Belgrade" "Europe/Berlin" "Europe/Bratislava" "Europe/Brussels" "Europe/Bucharest" "Europe/Budapest" "Europe/Busingen" "Europe/Chisinau" "Europe/Copenhagen" "Europe/Dublin" "Europe/Gibraltar" "Europe/Guernsey" "Europe/Helsinki" "Europe/Isle_of_Man" "Europe/Istanbul" "Europe/Jersey" "Europe/Kaliningrad" "Europe/Kirov" "Europe/Kyiv" "Europe/Lisbon" "Europe/Ljubljana" "Europe/London" "Europe/Luxembourg" "Europe/Madrid" "Europe/Malta" "Europe/Mariehamn" "Europe/Minsk" "Europe/Monaco" "Europe/Moscow" "Europe/Nicosia" "Europe/Oslo" "Europe/Paris" "Europe/Podgorica" "Europe/Prague" "Europe/Riga" "Europe/Rome" "Europe/Samara" "Europe/San_Marino" "Europe/Sarajevo" "Europe/Saratov" "Europe/Simferopol" "Europe/Skopje" "Europe/Sofia" "Europe/Stockholm" "Europe/Tallinn" "Europe/Tirane" "Europe/Tiraspol" "Europe/Ulyanovsk" "Europe/Vaduz" "Europe/Vatican" "Europe/Vienna" "Europe/Vilnius" "Europe/Volgograd" "Europe/Warsaw" "Europe/Zagreb" "Europe/Zurich" "Factory" "GMT" "Indian/Antananarivo" "Indian/Chagos" "Indian/Christmas" "Indian/Cocos" "Indian/Comoro" "Indian/Kerguelen" "Indian/Mahe" "Indian/Maldives" "Indian/Mauritius" "Indian/Mayotte" "Indian/Reunion" "Pacific/Apia" "Pacific/Auckland" "Pacific/Bougainville" "Pacific/Chatham" "Pacific/Chuuk" "Pacific/Easter" "Pacific/Efate" "Pacific/Fakaofo" "Pacific/Fiji" "Pacific/Funafuti" "Pacific/Galapagos" "Pacific/Gambier" "Pacific/Guadalcanal" "Pacific/Guam" "Pacific/Honolulu" "Pacific/Johnston" "Pacific/Kanton" "Pacific/Kiritimati" "Pacific/Kosrae" "Pacific/Kwajalein" "Pacific/Majuro" "Pacific/Marquesas" "Pacific/Midway" "Pacific/Nauru" "Pacific/Niue" "Pacific/Norfolk" "Pacific/Noumea" "Pacific/Pago_Pago" "Pacific/Palau" "Pacific/Pitcairn" "Pacific/Pohnpei" "Pacific/Port_Moresby" "Pacific/Rarotonga" "Pacific/Saipan" "Pacific/Samoa" "Pacific/Tahiti" "Pacific/Tarawa" "Pacific/Tongatapu" "Pacific/Wake" "Pacific/Wallis" "Pacific/Yap" "UTC"
email	string Email address - requires password to be set for OAuth users
email_confirmation	string must match email field when provided

Responses

Request samples

Payload

Content type

multipart/form-data

Example

updates user profile

{
  "pin": "1234",
  "first_name": "John",
  "last_name": "Doe",
  "phone_number": "+1 555 123 4567",
  "birthday": "1985-05-03",
  "avatar": "#<ActionDispatch::Http::UploadedFile:0x00007fa8ddfcdd60>",
  "unit_system": "metric",
  "is_biometrics_enabled": true,
  "active_circle_id": 1,
  "time_zone": "UTC",
  "email": "new.email@example.com",
  "email_confirmation": "new.email@example.com"
}

Response samples

200
401
404
422

Content type

application/json

{"id": 1587,
"first_name": "John",
"last_name": "Doe",
"email": "user1585@example.com",
"phone_number": {"code": "+1",
"number": "(555) 123-4567"
},
"birthday": "1985-05-03",
"avatar_url": "http://minio:9000/caily-private/private_store/user/1587/example-image20251205-82-fb8hbr-1587.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=minioadmin%2F20251205%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20251205T120726Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=21fc90784e14890ddd26d61dc53cbfb04acf568e56f2cffa08bb219e8a99081b",
"unit_system": "metric",
"confirmed": false,
"onboarding_completed": true,
"has_password": true,
"is_biometrics_enabled": true,
"time_zone": "UTC",
"active_circle_id": 824,
"locale": "en",
"placeholder_avatar_data": {"initials": "JD",
"background_color": "#3C5322"
},
"free_trial_available": true,
"can_manage_subscription": false,
"changed_email": "email@example.com"
}

Show current user's organization subscription

Authorizations:

Bearer Token

Responses

Response samples

200
401
404

Content type

application/json

{"id": 111,
"subscription_plan": {"id": 491,
"name": "Complete",
"key": "complete",
"feature_groups": [{"name": "Daily check-ins",
"key": "daily_check_ins",
"icon_url": "https://assets.example.com/assets/daily_check_ins-a64a6dda538ca21c3276645992fe369d2f1504a967486117a9e39520484f854f.svg"
},
{"name": "Chat",
"key": "chat",
"icon_url": "https://assets.example.com/assets/chat-ab77da71886ed740b72c5843b3f25134df165dfcb29a4e5d31268801f9c41534.svg"
},
{"name": "Health",
"key": "health",
"icon_url": "https://assets.example.com/assets/health-2b31489dbf7e2cf9d8e0507b886708c7362876215038f16de4d1446553b12f86.svg"
},
{"name": "Vault",
"key": "vault",
"icon_url": "https://assets.example.com/assets/vault-0b625efa840333fef7a22e73f38496624a41c4eaa4f73ff199f42082bb7121f4.svg"
},
{"name": "Schedule",
"key": "schedule",
"icon_url": "https://assets.example.com/assets/schedule-64761b0574a9644c957be24789466acd6dd3f28deea7f38fdf1bc9bd44cf5730.svg"
}
]
},
"organization": {"id": 257,
"name": "Ritchie, Fisher and Considine 153"
}
}

Request restricted access

Authorizations:

Bearer Token

Request Body schema: application/json

pin	string user pin, required if circle has pin auth required for scope
scope required	string Enum: "health" "vault"
circle_id required	integer

Responses

Request samples

Payload

Content type

application/json

{"scope": "health",
"circle_id": 1,
"pin": "1234"
}

Response samples

200
401
404
422

Content type

application/json

{"access_token": "Z1DfoXaMSQo7XhemmBfAlpADQdmIeDGBU3sgwfOhqSg",
"token_type": "Bearer",
"expires_in": 300,
"created_at": 1764936446,
"scope": "health",
"refresh_token": "uuZw3cEpYxfg1jiVlq6OCRMOl6jfTxL8kwGSWKrakv0"
}

Show current user's subscription

Authorizations:

Bearer Token

Responses

Response samples

200
401
404

Content type

application/json

{"id": 503,
"price": 1000,
"currency": "usd",
"currency_symbol": "$",
"status": "active",
"current_billing_period_ends_at": "2026-01-05T12:07:26.399076Z",
"cancel_at": null,
"is_trial": false,
"subscription_plan": {"id": 494,
"name": "Package 15",
"key": "package_15",
"feature_groups": [{"name": "Health",
"key": "health",
"icon_url": "https://assets.example.com/assets/health-2b31489dbf7e2cf9d8e0507b886708c7362876215038f16de4d1446553b12f86.svg"
},
{"name": "Vault",
"key": "vault",
"icon_url": "https://assets.example.com/assets/vault-0b625efa840333fef7a22e73f38496624a41c4eaa4f73ff199f42082bb7121f4.svg"
}
]
},
"subscription_package": {"id": 1,
"provider": "stripe",
"external_package_id": "2331566270",
"billing_period_type": "monthly"
},
"trial_ends_at": null
}

Validate current user's pin

Authorizations:

Bearer Token

Request Body schema: application/json

pin	string user pin

Responses

Request samples

Payload

Content type

application/json

{"pin": "1234"
}

Response samples

401
422

Content type

application/json

Example

when user is not authorized

{"error": {"code": "unauthorized",
"details": [{"key": "_base",
"message": "Session has expired"
}
]
}
}

[COMMON] Notification Settings

Show current user's notification settings

Authorizations:

Bearer Token

Responses

Response samples

200
401

Content type

application/json

[{"notification_category_id": 2036,
"notification_type": "new_circle_invitation",
"notification_type_label": "New circle invitation",
"notification_group": "circle",
"notification_group_label": "Circle",
"push_possible": true,
"in_app_possible": true,
"push_enabled": true,
"in_app_enabled": true
},
{"notification_category_id": 2037,
"notification_type": "new_circle_member",
"notification_type_label": "New circle member",
"notification_group": "circle",
"notification_group_label": "Circle",
"push_possible": true,
"in_app_possible": true,
"push_enabled": true,
"in_app_enabled": true
},
{"notification_category_id": 2038,
"notification_type": "join_request_accept",
"notification_type_label": "Join request accept",
"notification_group": "circle",
"notification_group_label": "Circle",
"push_possible": true,
"in_app_possible": true,
"push_enabled": true,
"in_app_enabled": true
},
{"notification_category_id": 2039,
"notification_type": "circle_member_left",
"notification_type_label": "Circle member left",
"notification_group": "circle",
"notification_group_label": "Circle",
"push_possible": true,
"in_app_possible": true,
"push_enabled": true,
"in_app_enabled": true
},
{"notification_category_id": 2040,
"notification_type": "circle_member_role_change",
"notification_type_label": "Circle member role change",
"notification_group": "circle",
"notification_group_label": "Circle",
"push_possible": false,
"in_app_possible": true,
"push_enabled": false,
"in_app_enabled": true
},
{"notification_category_id": 2041,
"notification_type": "user_removed_from_circle",
"notification_type_label": "User removed from circle",
"notification_group": "circle",
"notification_group_label": "Circle",
"push_possible": true,
"in_app_possible": true,
"push_enabled": true,
"in_app_enabled": true
},
{"notification_category_id": 2059,
"notification_type": "circle_deleted",
"notification_type_label": "Circle deleted",
"notification_group": "circle",
"notification_group_label": "Circle",
"push_possible": true,
"in_app_possible": true,
"push_enabled": true,
"in_app_enabled": true
},
{"notification_category_id": 2042,
"notification_type": "missed_medication",
"notification_type_label": "Missed medication",
"notification_group": "health",
"notification_group_label": "Health",
"push_possible": true,
"in_app_possible": true,
"push_enabled": true,
"in_app_enabled": true
},
{"notification_category_id": 2043,
"notification_type": "medication_alert",
"notification_type_label": "Medication alert",
"notification_group": "health",
"notification_group_label": "Health",
"push_possible": true,
"in_app_possible": true,
"push_enabled": true,
"in_app_enabled": true
},
{"notification_category_id": 2044,
"notification_type": "new_note",
"notification_type_label": "New note",
"notification_group": "health",
"notification_group_label": "Health",
"push_possible": false,
"in_app_possible": true,
"push_enabled": false,
"in_app_enabled": true
},
{"notification_category_id": 2045,
"notification_type": "note_edit",
"notification_type_label": "Note edit",
"notification_group": "health",
"notification_group_label": "Health",
"push_possible": false,
"in_app_possible": true,
"push_enabled": false,
"in_app_enabled": true
},
{"notification_category_id": 2046,
"notification_type": "new_symptom_log",
"notification_type_label": "New symptom log",
"notification_group": "health",
"notification_group_label": "Health",
"push_possible": false,
"in_app_possible": true,
"push_enabled": false,
"in_app_enabled": true
},
{"notification_category_id": 2047,
"notification_type": "new_daily_living_activity_log",
"notification_type_label": "New daily living activity log",
"notification_group": "health",
"notification_group_label": "Health",
"push_possible": false,
"in_app_possible": true,
"push_enabled": false,
"in_app_enabled": true
},
{"notification_category_id": 2049,
"notification_type": "carereceiver_documentation_edit",
"notification_type_label": "Carereceiver documentation update",
"notification_group": "health",
"notification_group_label": "Health",
"push_possible": false,
"in_app_possible": true,
"push_enabled": false,
"in_app_enabled": true
},
{"notification_category_id": 2048,
"notification_type": "new_vital_sign_log",
"notification_type_label": "New vital sign log",
"notification_group": "health",
"notification_group_label": "Health",
"push_possible": false,
"in_app_possible": true,
"push_enabled": false,
"in_app_enabled": true
},
{"notification_category_id": 2050,
"notification_type": "event_alert",
"notification_type_label": "Event alert",
"notification_group": "events",
"notification_group_label": "Events",
"push_possible": true,
"in_app_possible": true,
"push_enabled": true,
"in_app_enabled": true
},
{"notification_category_id": 2051,
"notification_type": "task_alert",
"notification_type_label": "Task alert",
"notification_group": "tasks",
"notification_group_label": "Tasks",
"push_possible": true,
"in_app_possible": true,
"push_enabled": true,
"in_app_enabled": true
},
{"notification_category_id": 2052,
"notification_type": "habit_alert",
"notification_type_label": "Habit alert",
"notification_group": "habits",
"notification_group_label": "Habits",
"push_possible": true,
"in_app_possible": true,
"push_enabled": true,
"in_app_enabled": true
},
{"notification_category_id": 2053,
"notification_type": "missed_habit",
"notification_type_label": "Missed habit",
"notification_group": "habits",
"notification_group_label": "Habits",
"push_possible": true,
"in_app_possible": true,
"push_enabled": true,
"in_app_enabled": true
},
{"notification_category_id": 2054,
"notification_type": "vault_update",
"notification_type_label": "Vault update",
"notification_group": "vault",
"notification_group_label": "Vault",
"push_possible": false,
"in_app_possible": true,
"push_enabled": false,
"in_app_enabled": true
},
{"notification_category_id": 2055,
"notification_type": "vault_document_update",
"notification_type_label": "Vault document update",
"notification_group": "vault",
"notification_group_label": "Vault",
"push_possible": false,
"in_app_possible": true,
"push_enabled": false,
"in_app_enabled": true
},
{"notification_category_id": 2056,
"notification_type": "new_vault_task",
"notification_type_label": "New vault task",
"notification_group": "vault",
"notification_group_label": "Vault",
"push_possible": false,
"in_app_possible": true,
"push_enabled": false,
"in_app_enabled": true
},
{"notification_category_id": 2057,
"notification_type": "new_message",
"notification_type_label": "New message",
"notification_group": "chat",
"notification_group_label": "Chat",
"push_possible": true,
"in_app_possible": false,
"push_enabled": true,
"in_app_enabled": false
},
{"notification_category_id": 2058,
"notification_type": "new_conversation",
"notification_type_label": "New conversation",
"notification_group": "chat",
"notification_group_label": "Chat",
"push_possible": true,
"in_app_possible": true,
"push_enabled": true,
"in_app_enabled": true
}
]

Update current user's notification settings

Authorizations:

Bearer Token

Request Body schema: application/json

required

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"notification_settings": [{"notification_category_id": 0,
"push_enabled": true,
"in_app_enabled": true
}
]
}

Response samples

200
401
422

Content type

application/json

[{"notification_category_id": 2086,
"notification_type": "new_message",
"notification_type_label": "New message",
"notification_group": "circle",
"notification_group_label": "Circle",
"push_possible": true,
"in_app_possible": false,
"push_enabled": true,
"in_app_enabled": false
},
{"notification_category_id": 2085,
"notification_type": "new_circle_invitation",
"notification_type_label": "New circle invitation",
"notification_group": "tasks",
"notification_group_label": "Tasks",
"push_possible": false,
"in_app_possible": true,
"push_enabled": false,
"in_app_enabled": true
}
]

[COMMON] Users

Reset current user's pin

Authorizations:

Bearer Token

Responses

Response samples

401
422

Content type

application/json

{"error": {"code": "unauthorized",
"details": [{"key": "_base",
"message": "Session has expired"
}
]
}
}

Confirm email change

Request Body schema: application/json

token required	string
scope required	string Enum: "web" "mobile"

Responses

Request samples

Payload

Content type

application/json

{"token": "token",
"scope": "web"
}

Response samples

200
404
422

Content type

application/json

{"access_token": "jy12aIoa2cle33pPbOhxzfz-nwpn_zXZ8lEIIrrGEVc",
"token_type": "Bearer",
"expires_in": 900,
"created_at": 1764936453,
"refresh_token": "Ats8fCiS-d_WhhbxTaG-zh3R_3npZmZs7GclTCjDR74",
"user": {"id": 1894,
"first_name": "Desiree Gottlieb",
"last_name": "Quyen Dach",
"email": "new@example.com",
"phone_number": null,
"birthday": "1992-09-15",
"avatar_url": null,
"unit_system": "imperial",
"confirmed": false,
"onboarding_completed": false,
"has_password": true,
"is_biometrics_enabled": false,
"time_zone": "UTC",
"active_circle_id": null,
"locale": "en",
"placeholder_avatar_data": {"initials": "FF",
"background_color": "#FF0000"
},
"free_trial_available": true,
"can_manage_subscription": false,
"changed_email": null
}
}

Confirm account

Request Body schema: application/json

token required	string
scope required	string Enum: "web" "mobile"

Responses

Request samples

Payload

Content type

application/json

{"token": "token",
"scope": "mobile"
}

Response samples

200
404
422

Content type

application/json

{"access_token": "JUFW8O80DJRw0lJIb-bmr4KhQJ2YLgX5_SZlSGII1m0",
"token_type": "Bearer",
"expires_in": 900,
"created_at": 1764936454,
"refresh_token": "WE9rjJXU3lsvfnwxTH83DY02SSfai6cc9v4pMKaxcCM",
"user": {"id": 1897,
"first_name": "Dylan Larkin",
"last_name": "Sonny Smith",
"email": "user1890@example.com",
"phone_number": null,
"birthday": "1967-07-30",
"avatar_url": null,
"unit_system": "imperial",
"confirmed": true,
"onboarding_completed": false,
"has_password": true,
"is_biometrics_enabled": false,
"time_zone": "UTC",
"active_circle_id": null,
"locale": "en",
"placeholder_avatar_data": {"initials": "FF",
"background_color": "#FF0000"
},
"free_trial_available": true,
"can_manage_subscription": false,
"changed_email": null
}
}

User sign up (by email)

Request Body schema: application/json

email required	string
password required	string min. 8 characters, min. one capital letter, min. one digit, min. one special character, min. one lower case letter
organization_invitation_token	string or null

Responses

Request samples

Payload

Content type

application/json

{"email": "john.doe@example.com",
"password": "Password100!"
}

Response samples

201
422

Content type

application/json

{"id": 1900,
"first_name": null,
"last_name": null,
"email": "john.doe@example.com",
"phone_number": null,
"birthday": null,
"avatar_url": null,
"unit_system": "imperial",
"confirmed": false,
"onboarding_completed": false,
"has_password": true,
"is_biometrics_enabled": false,
"time_zone": "UTC",
"active_circle_id": null,
"locale": "en",
"placeholder_avatar_data": {"background_color": "#A30F44",
"initials": "J"
},
"free_trial_available": true,
"can_manage_subscription": false,
"changed_email": null
}

Resend verification code

query Parameters

email

required

any

Responses

Response samples

422

Content type

application/json

{"error": {"code": "validation_error",
"details": [{"key": "email",
"message": "Email address must be filled"
}
]
}
}

Reset password

Request Body schema: application/json

email

required

string

Responses

Request samples

Payload

Content type

application/json

{"email": "john.doe@example.com"
}

Response samples

422

Content type

application/json

{"error": {"code": "validation_error",
"details": [{"key": "email",
"message": "Email address must be filled"
}
]
}
}

Set new password

Request Body schema: application/json

token required	string
password required	string

Responses

Request samples

Payload

Content type

application/json

{"password": "New-password123!@#",
"token": "password-reset-token"
}

Response samples

422

Content type

application/json

Example

when invalid params

{"error": {"code": "validation_error",
"details": [{"key": "token",
"message": "Token must be filled"
}
]
}
}

Set new pin

Request Body schema: application/json

token required	string
pin required	string

Responses

Request samples

Payload

Content type

application/json

{"pin": "1234",
"token": "pin-reset-token"
}

Response samples

422

Content type

application/json

Example

when invalid params

{"error": {"code": "validation_error",
"details": [{"key": "token",
"message": "Token must be filled"
},
{"key": "pin",
"message": "PIN Code must be filled"
}
]
}
}

[COMMON] Sessions

Sign in / Refresh token

Request Body schema: application/json

refresh_token	string only in case of grant_type=refresh_token
email	string only in case of grant_type=password
password	string only in case of grant_type=password
token	string only in case of grant_type=assertion
organization_invitation_token	string or null only in case of grant_type=assertion (optional) - links user to employee record
grant_type required	string Enum: "password" "assertion" "refresh_token"
scope required	string Enum: "web" "mobile"

Responses

Request samples

Payload

Content type

application/json

Example

Sign in via email

{"email": "john.doe@caily.com",
"password": "password",
"grant_type": "password",
"scope": "web"
}

Response samples

200
400

Content type

application/json

Example

web

{"access_token": "vI2smVh9tBQgbzBtHQgpBkSPLQaauS0kdFPjtUdgl3o",
"token_type": "Bearer",
"expires_in": 900,
"refresh_token": "0boXhTa0wOzuChbcTocLaj1D9XEUCTqinsAhCBwj9Ng",
"scope": "web",
"created_at": 1728561600,
"user": {"id": 1601,
"first_name": "The Hon. Vanesa King",
"last_name": "Otto DuBuque",
"email": "user1598@example.com",
"phone_number": null,
"birthday": "1964-11-06",
"avatar_url": null,
"unit_system": "imperial",
"confirmed": true,
"onboarding_completed": false,
"has_password": true,
"is_biometrics_enabled": false,
"time_zone": "UTC",
"active_circle_id": null,
"locale": "en",
"placeholder_avatar_data": {"initials": "FF",
"background_color": "#FF0000"
},
"free_trial_available": true,
"can_manage_subscription": false,
"changed_email": null
}
}

Logout

Request Body schema: application/json

token required	string
device_token	string

Responses

Request samples

Payload

Content type

application/json

{"token": "RMFTakb-8kWVknGmqAHsmvWrY_aUXpBc4N2-GdHOC6I",
"device_token": "uo4fpql61ql2ih6im3tylc8becuj3aot"
}

[COMMON] Stripe

Create billing portal session

Authorizations:

Bearer Token

Responses

Response samples

201
401
422

Content type

application/json

{"id": "billing_portal_session_id",
"url": "https://billing.stripe.com/p/login/test_billing_portal_session_id"
}

[COMMON] Subscriptions

Activate free trial

Authorizations:

Bearer Token

Responses

Response samples

201
401
422

Content type

application/json

{"id": 506,
"price": 0,
"currency": "usd",
"currency_symbol": "$",
"status": "active",
"current_billing_period_ends_at": "2025-12-12T12:07:27.352908Z",
"cancel_at": "2025-12-12T12:07:27.352908Z",
"is_trial": true,
"subscription_plan": {"id": 497,
"name": "Package 18",
"key": "package_18",
"feature_groups": [{"name": "Health",
"key": "health",
"icon_url": "https://assets.example.com/assets/health-2b31489dbf7e2cf9d8e0507b886708c7362876215038f16de4d1446553b12f86.svg"
},
{"name": "Vault",
"key": "vault",
"icon_url": "https://assets.example.com/assets/vault-0b625efa840333fef7a22e73f38496624a41c4eaa4f73ff199f42082bb7121f4.svg"
}
]
},
"subscription_package": null,
"trial_ends_at": "2025-12-12T12:07:27.352908Z"
}

[COMMON] Symptom Logs

Create symptom log

Authorizations:

Bearer Token

Request Body schema: application/json

circle_symptom_id required	integer
occurrence_time required	string <date_time>
severity required	integer must be one of [0, 1, 2, 3, 4, 5]
lasted_for required	string Lasted For eg. 2 hours
notes	string or null

Responses

Request samples

Payload

Content type

application/json

{"circle_symptom_id": 0,
"occurrence_time": "string",
"severity": 0,
"lasted_for": "string",
"notes": "string"
}

Response samples

201
401
403
404
422

Content type

application/json

{"id": 1,
"circle_symptom": {"id": 15,
"symptom": null,
"name": "Back pain"
},
"occurrence_time": "2025-12-05T12:07:27.448000Z",
"severity": 0,
"lasted_for": "1 hour",
"notes": "Some notes",
"created_at": "2025-12-05T12:07:27.463231Z"
}

Get symptom logs

Authorizations:

Bearer Token

query Parameters

circle_symptom_id required	integer Filter by circle symptom ID
date	date Filter by date
month	integer Filter by month (1-12)
year	integer Filter by year (YYYY)
cursor	integer cursor by occurrence_time
items_per_page	integer
direction	string
time_zone required	string Enum: "Africa/Abidjan" "Africa/Accra" "Africa/Addis_Ababa" "Africa/Algiers" "Africa/Asmara" "Africa/Bamako" "Africa/Bangui" "Africa/Banjul" "Africa/Bissau" "Africa/Blantyre" "Africa/Brazzaville" "Africa/Bujumbura" "Africa/Cairo" "Africa/Casablanca" "Africa/Ceuta" "Africa/Conakry" "Africa/Dakar" "Africa/Dar_es_Salaam" "Africa/Djibouti" "Africa/Douala" "Africa/El_Aaiun" "Africa/Freetown" "Africa/Gaborone" "Africa/Harare" "Africa/Johannesburg" "Africa/Juba" "Africa/Kampala" "Africa/Khartoum" "Africa/Kigali" "Africa/Kinshasa" "Africa/Lagos" "Africa/Libreville" "Africa/Lome" "Africa/Luanda" "Africa/Lubumbashi" "Africa/Lusaka" "Africa/Malabo" "Africa/Maputo" "Africa/Maseru" "Africa/Mbabane" "Africa/Mogadishu" "Africa/Monrovia" "Africa/Nairobi" "Africa/Ndjamena" "Africa/Niamey" "Africa/Nouakchott" "Africa/Ouagadougou" "Africa/Porto-Novo" "Africa/Sao_Tome" "Africa/Timbuktu" "Africa/Tripoli" "Africa/Tunis" "Africa/Windhoek" "America/Adak" "America/Anchorage" "America/Anguilla" "America/Antigua" "America/Araguaina" "America/Argentina/Buenos_Aires" "America/Argentina/Catamarca" "America/Argentina/Cordoba" "America/Argentina/Jujuy" "America/Argentina/La_Rioja" "America/Argentina/Mendoza" "America/Argentina/Rio_Gallegos" "America/Argentina/Salta" "America/Argentina/San_Juan" "America/Argentina/San_Luis" "America/Argentina/Tucuman" "America/Argentina/Ushuaia" "America/Aruba" "America/Asuncion" "America/Atikokan" "America/Atka" "America/Bahia" "America/Bahia_Banderas" "America/Barbados" "America/Belem" "America/Belize" "America/Blanc-Sablon" "America/Boa_Vista" "America/Bogota" "America/Boise" "America/Cambridge_Bay" "America/Campo_Grande" "America/Cancun" "America/Caracas" "America/Cayenne" "America/Cayman" "America/Chicago" "America/Chihuahua" "America/Ciudad_Juarez" "America/Coral_Harbour" "America/Costa_Rica" "America/Creston" "America/Cuiaba" "America/Curacao" "America/Danmarkshavn" "America/Dawson" "America/Dawson_Creek" "America/Denver" "America/Detroit" "America/Dominica" "America/Edmonton" "America/Eirunepe" "America/El_Salvador" "America/Ensenada" "America/Fort_Nelson" "America/Fortaleza" "America/Glace_Bay" "America/Goose_Bay" "America/Grand_Turk" "America/Grenada" "America/Guadeloupe" "America/Guatemala" "America/Guayaquil" "America/Guyana" "America/Halifax" "America/Havana" "America/Hermosillo" "America/Indiana/Indianapolis" "America/Indiana/Knox" "America/Indiana/Marengo" "America/Indiana/Petersburg" "America/Indiana/Tell_City" "America/Indiana/Vevay" "America/Indiana/Vincennes" "America/Indiana/Winamac" "America/Inuvik" "America/Iqaluit" "America/Jamaica" "America/Juneau" "America/Kentucky/Louisville" "America/Kentucky/Monticello" "America/Kralendijk" "America/La_Paz" "America/Lima" "America/Los_Angeles" "America/Lower_Princes" "America/Maceio" "America/Managua" "America/Manaus" "America/Marigot" "America/Martinique" "America/Matamoros" "America/Mazatlan" "America/Menominee" "America/Merida" "America/Metlakatla" "America/Mexico_City" "America/Miquelon" "America/Moncton" "America/Monterrey" "America/Montevideo" "America/Montreal" "America/Montserrat" "America/Nassau" "America/New_York" "America/Nipigon" "America/Nome" "America/Noronha" "America/North_Dakota/Beulah" "America/North_Dakota/Center" "America/North_Dakota/New_Salem" "America/Nuuk" "America/Ojinaga" "America/Panama" "America/Pangnirtung" "America/Paramaribo" "America/Phoenix" "America/Port-au-Prince" "America/Port_of_Spain" "America/Porto_Acre" "America/Porto_Velho" "America/Puerto_Rico" "America/Punta_Arenas" "America/Rainy_River" "America/Rankin_Inlet" "America/Recife" "America/Regina" "America/Resolute" "America/Rio_Branco" "America/Santa_Isabel" "America/Santarem" "America/Santiago" "America/Santo_Domingo" "America/Sao_Paulo" "America/Scoresbysund" "America/Shiprock" "America/Sitka" "America/St_Barthelemy" "America/St_Johns" "America/St_Kitts" "America/St_Lucia" "America/St_Thomas" "America/St_Vincent" "America/Swift_Current" "America/Tegucigalpa" "America/Thule" "America/Thunder_Bay" "America/Tijuana" "America/Toronto" "America/Tortola" "America/Vancouver" "America/Virgin" "America/Whitehorse" "America/Winnipeg" "America/Yakutat" "America/Yellowknife" "Antarctica/Casey" "Antarctica/Davis" "Antarctica/DumontDUrville" "Antarctica/Macquarie" "Antarctica/Mawson" "Antarctica/McMurdo" "Antarctica/Palmer" "Antarctica/Rothera" "Antarctica/Syowa" "Antarctica/Troll" "Antarctica/Vostok" "Arctic/Longyearbyen" "Asia/Aden" "Asia/Almaty" "Asia/Amman" "Asia/Anadyr" "Asia/Aqtau" "Asia/Aqtobe" "Asia/Ashgabat" "Asia/Atyrau" "Asia/Baghdad" "Asia/Bahrain" "Asia/Baku" "Asia/Bangkok" "Asia/Barnaul" "Asia/Beirut" "Asia/Bishkek" "Asia/Brunei" "Asia/Chita" "Asia/Chongqing" "Asia/Colombo" "Asia/Damascus" "Asia/Dhaka" "Asia/Dili" "Asia/Dubai" "Asia/Dushanbe" "Asia/Famagusta" "Asia/Gaza" "Asia/Harbin" "Asia/Hebron" "Asia/Ho_Chi_Minh" "Asia/Hong_Kong" "Asia/Hovd" "Asia/Irkutsk" "Asia/Istanbul" "Asia/Jakarta" "Asia/Jayapura" "Asia/Jerusalem" "Asia/Kabul" "Asia/Kamchatka" "Asia/Karachi" "Asia/Kashgar" "Asia/Kathmandu" "Asia/Khandyga" "Asia/Kolkata" "Asia/Krasnoyarsk" "Asia/Kuala_Lumpur" "Asia/Kuching" "Asia/Kuwait" "Asia/Macau" "Asia/Magadan" "Asia/Makassar" "Asia/Manila" "Asia/Muscat" "Asia/Nicosia" "Asia/Novokuznetsk" "Asia/Novosibirsk" "Asia/Omsk" "Asia/Oral" "Asia/Phnom_Penh" "Asia/Pontianak" "Asia/Pyongyang" "Asia/Qatar" "Asia/Qostanay" "Asia/Qyzylorda" "Asia/Riyadh" "Asia/Sakhalin" "Asia/Samarkand" "Asia/Seoul" "Asia/Shanghai" "Asia/Singapore" "Asia/Srednekolymsk" "Asia/Taipei" "Asia/Tashkent" "Asia/Tbilisi" "Asia/Tehran" "Asia/Tel_Aviv" "Asia/Thimphu" "Asia/Tokyo" "Asia/Tomsk" "Asia/Ulaanbaatar" "Asia/Urumqi" "Asia/Ust-Nera" "Asia/Vientiane" "Asia/Vladivostok" "Asia/Yakutsk" "Asia/Yangon" "Asia/Yekaterinburg" "Asia/Yerevan" "Atlantic/Azores" "Atlantic/Bermuda" "Atlantic/Canary" "Atlantic/Cape_Verde" "Atlantic/Faroe" "Atlantic/Jan_Mayen" "Atlantic/Madeira" "Atlantic/Reykjavik" "Atlantic/South_Georgia" "Atlantic/St_Helena" "Atlantic/Stanley" "Australia/Adelaide" "Australia/Brisbane" "Australia/Broken_Hill" "Australia/Canberra" "Australia/Currie" "Australia/Darwin" "Australia/Eucla" "Australia/Hobart" "Australia/Lindeman" "Australia/Lord_Howe" "Australia/Melbourne" "Australia/Perth" "Australia/Sydney" "Australia/Yancowinna" "Etc/GMT" "Etc/GMT+0" "Etc/GMT+1" "Etc/GMT+10" "Etc/GMT+11" "Etc/GMT+12" "Etc/GMT+2" "Etc/GMT+3" "Etc/GMT+4" "Etc/GMT+5" "Etc/GMT+6" "Etc/GMT+7" "Etc/GMT+8" "Etc/GMT+9" "Etc/GMT-0" "Etc/GMT-1" "Etc/GMT-10" "Etc/GMT-11" "Etc/GMT-12" "Etc/GMT-13" "Etc/GMT-14" "Etc/GMT-2" "Etc/GMT-3" "Etc/GMT-4" "Etc/GMT-5" "Etc/GMT-6" "Etc/GMT-7" "Etc/GMT-8" "Etc/GMT-9" "Etc/GMT0" "Etc/Greenwich" "Etc/UCT" "Etc/UTC" "Etc/Universal" "Etc/Zulu" "Europe/Amsterdam" "Europe/Andorra" "Europe/Astrakhan" "Europe/Athens" "Europe/Belfast" "Europe/Belgrade" "Europe/Berlin" "Europe/Bratislava" "Europe/Brussels" "Europe/Bucharest" "Europe/Budapest" "Europe/Busingen" "Europe/Chisinau" "Europe/Copenhagen" "Europe/Dublin" "Europe/Gibraltar" "Europe/Guernsey" "Europe/Helsinki" "Europe/Isle_of_Man" "Europe/Istanbul" "Europe/Jersey" "Europe/Kaliningrad" "Europe/Kirov" "Europe/Kyiv" "Europe/Lisbon" "Europe/Ljubljana" "Europe/London" "Europe/Luxembourg" "Europe/Madrid" "Europe/Malta" "Europe/Mariehamn" "Europe/Minsk" "Europe/Monaco" "Europe/Moscow" "Europe/Nicosia" "Europe/Oslo" "Europe/Paris" "Europe/Podgorica" "Europe/Prague" "Europe/Riga" "Europe/Rome" "Europe/Samara" "Europe/San_Marino" "Europe/Sarajevo" "Europe/Saratov" "Europe/Simferopol" "Europe/Skopje" "Europe/Sofia" "Europe/Stockholm" "Europe/Tallinn" "Europe/Tirane" "Europe/Tiraspol" "Europe/Ulyanovsk" "Europe/Vaduz" "Europe/Vatican" "Europe/Vienna" "Europe/Vilnius" "Europe/Volgograd" "Europe/Warsaw" "Europe/Zagreb" "Europe/Zurich" "Factory" "GMT" "Indian/Antananarivo" "Indian/Chagos" "Indian/Christmas" "Indian/Cocos" "Indian/Comoro" "Indian/Kerguelen" "Indian/Mahe" "Indian/Maldives" "Indian/Mauritius" "Indian/Mayotte" "Indian/Reunion" "Pacific/Apia" "Pacific/Auckland" "Pacific/Bougainville" "Pacific/Chatham" "Pacific/Chuuk" "Pacific/Easter" "Pacific/Efate" "Pacific/Fakaofo" "Pacific/Fiji" "Pacific/Funafuti" "Pacific/Galapagos" "Pacific/Gambier" "Pacific/Guadalcanal" "Pacific/Guam" "Pacific/Honolulu" "Pacific/Johnston" "Pacific/Kanton" "Pacific/Kiritimati" "Pacific/Kosrae" "Pacific/Kwajalein" "Pacific/Majuro" "Pacific/Marquesas" "Pacific/Midway" "Pacific/Nauru" "Pacific/Niue" "Pacific/Norfolk" "Pacific/Noumea" "Pacific/Pago_Pago" "Pacific/Palau" "Pacific/Pitcairn" "Pacific/Pohnpei" "Pacific/Port_Moresby" "Pacific/Rarotonga" "Pacific/Saipan" "Pacific/Samoa" "Pacific/Tahiti" "Pacific/Tarawa" "Pacific/Tongatapu" "Pacific/Wake" "Pacific/Wallis" "Pacific/Yap" "UTC"

Responses

Response samples

200
401
403
404
422

Content type

application/json

[{"id": 19,
"circle_symptom": {"id": 36,
"symptom": null,
"name": null
},
"occurrence_time": "2025-12-07T12:07:28.445593Z",
"severity": 0,
"lasted_for": "2 hours",
"notes": "Some notes",
"created_at": "2025-12-05T12:07:28.451443Z"
},
{"id": 17,
"circle_symptom": {"id": 36,
"symptom": null,
"name": null
},
"occurrence_time": "2025-12-06T12:07:28.445593Z",
"severity": 5,
"lasted_for": "2 hours",
"notes": "Some notes",
"created_at": "2025-12-05T12:07:28.448439Z"
},
{"id": 16,
"circle_symptom": {"id": 36,
"symptom": null,
"name": null
},
"occurrence_time": "2025-12-05T12:07:28.445593Z",
"severity": 4,
"lasted_for": "2 hours",
"notes": "Some notes",
"created_at": "2025-12-05T12:07:28.446580Z"
}
]

Destroy symptom log

Authorizations:

Bearer Token

path Parameters

id

required

integer

Symptom Log ID

Responses

Response samples

401
403
404
422

Content type

application/json

{"error": {"code": "unauthorized",
"details": [{"key": "_base",
"message": "Session has expired"
}
]
}
}

Get single symptom log

Authorizations:

Bearer Token

path Parameters

id

required

integer

Symptom Log ID

Responses

Response samples

200
401
403
404
422

Content type

application/json

{"id": 44,
"circle_symptom": {"id": 50,
"symptom": null,
"name": null
},
"occurrence_time": "2025-12-05T00:00:00.000000Z",
"severity": 2,
"lasted_for": "2 hours",
"notes": "Some notes",
"created_at": "2025-12-05T12:07:28.738588Z"
}

Update symptom log

Authorizations:

Bearer Token

path Parameters

id

required

integer

Symptom Log ID

Request Body schema: application/json

occurrence_time	string <date_time>
severity	integer must be one of [0, 1, 2, 3, 4, 5]
lasted_for	string Lasted For eg. 2 hours
notes	string or null

Responses

Request samples

Payload

Content type

application/json

{"occurrence_time": "string",
"severity": 0,
"lasted_for": "string",
"notes": "string"
}

Response samples

200
401
403
404
422

Content type

application/json

{"id": 87,
"circle_symptom": {"id": 63,
"symptom": null,
"name": null
},
"occurrence_time": "2025-12-05T12:07:29.496000Z",
"severity": 1,
"lasted_for": "1 hour",
"notes": "Some notes",
"created_at": "2025-12-05T12:07:29.478001Z"
}

Export symptom logs to CSV

Authorizations:

Bearer Token

path Parameters

circle_symptom_id

required

integer

Circle Symptom ID

Responses

Response samples

401
403
404
422

Content type

application/json

{"error": {"code": "unauthorized",
"details": [{"key": "_base",
"message": "Session has expired"
}
]
}
}

Get symptom logs summary

Authorizations:

Bearer Token

path Parameters

circle_symptom_id

required

integer

query Parameters

time_zone

required

string

Enum: "Africa/Abidjan" "Africa/Accra" "Africa/Addis_Ababa" "Africa/Algiers" "Africa/Asmara" "Africa/Bamako" "Africa/Bangui" "Africa/Banjul" "Africa/Bissau" "Africa/Blantyre" "Africa/Brazzaville" "Africa/Bujumbura" "Africa/Cairo" "Africa/Casablanca" "Africa/Ceuta" "Africa/Conakry" "Africa/Dakar" "Africa/Dar_es_Salaam" "Africa/Djibouti" "Africa/Douala" "Africa/El_Aaiun" "Africa/Freetown" "Africa/Gaborone" "Africa/Harare" "Africa/Johannesburg" "Africa/Juba" "Africa/Kampala" "Africa/Khartoum" "Africa/Kigali" "Africa/Kinshasa" "Africa/Lagos" "Africa/Libreville" "Africa/Lome" "Africa/Luanda" "Africa/Lubumbashi" "Africa/Lusaka" "Africa/Malabo" "Africa/Maputo" "Africa/Maseru" "Africa/Mbabane" "Africa/Mogadishu" "Africa/Monrovia" "Africa/Nairobi" "Africa/Ndjamena" "Africa/Niamey" "Africa/Nouakchott" "Africa/Ouagadougou" "Africa/Porto-Novo" "Africa/Sao_Tome" "Africa/Timbuktu" "Africa/Tripoli" "Africa/Tunis" "Africa/Windhoek" "America/Adak" "America/Anchorage" "America/Anguilla" "America/Antigua" "America/Araguaina" "America/Argentina/Buenos_Aires" "America/Argentina/Catamarca" "America/Argentina/Cordoba" "America/Argentina/Jujuy" "America/Argentina/La_Rioja" "America/Argentina/Mendoza" "America/Argentina/Rio_Gallegos" "America/Argentina/Salta" "America/Argentina/San_Juan" "America/Argentina/San_Luis" "America/Argentina/Tucuman" "America/Argentina/Ushuaia" "America/Aruba" "America/Asuncion" "America/Atikokan" "America/Atka" "America/Bahia" "America/Bahia_Banderas" "America/Barbados" "America/Belem" "America/Belize" "America/Blanc-Sablon" "America/Boa_Vista" "America/Bogota" "America/Boise" "America/Cambridge_Bay" "America/Campo_Grande" "America/Cancun" "America/Caracas" "America/Cayenne" "America/Cayman" "America/Chicago" "America/Chihuahua" "America/Ciudad_Juarez" "America/Coral_Harbour" "America/Costa_Rica" "America/Creston" "America/Cuiaba" "America/Curacao" "America/Danmarkshavn" "America/Dawson" "America/Dawson_Creek" "America/Denver" "America/Detroit" "America/Dominica" "America/Edmonton" "America/Eirunepe" "America/El_Salvador" "America/Ensenada" "America/Fort_Nelson" "America/Fortaleza" "America/Glace_Bay" "America/Goose_Bay" "America/Grand_Turk" "America/Grenada" "America/Guadeloupe" "America/Guatemala" "America/Guayaquil" "America/Guyana" "America/Halifax" "America/Havana" "America/Hermosillo" "America/Indiana/Indianapolis" "America/Indiana/Knox" "America/Indiana/Marengo" "America/Indiana/Petersburg" "America/Indiana/Tell_City" "America/Indiana/Vevay" "America/Indiana/Vincennes" "America/Indiana/Winamac" "America/Inuvik" "America/Iqaluit" "America/Jamaica" "America/Juneau" "America/Kentucky/Louisville" "America/Kentucky/Monticello" "America/Kralendijk" "America/La_Paz" "America/Lima" "America/Los_Angeles" "America/Lower_Princes" "America/Maceio" "America/Managua" "America/Manaus" "America/Marigot" "America/Martinique" "America/Matamoros" "America/Mazatlan" "America/Menominee" "America/Merida" "America/Metlakatla" "America/Mexico_City" "America/Miquelon" "America/Moncton" "America/Monterrey" "America/Montevideo" "America/Montreal" "America/Montserrat" "America/Nassau" "America/New_York" "America/Nipigon" "America/Nome" "America/Noronha" "America/North_Dakota/Beulah" "America/North_Dakota/Center" "America/North_Dakota/New_Salem" "America/Nuuk" "America/Ojinaga" "America/Panama" "America/Pangnirtung" "America/Paramaribo" "America/Phoenix" "America/Port-au-Prince" "America/Port_of_Spain" "America/Porto_Acre" "America/Porto_Velho" "America/Puerto_Rico" "America/Punta_Arenas" "America/Rainy_River" "America/Rankin_Inlet" "America/Recife" "America/Regina" "America/Resolute" "America/Rio_Branco" "America/Santa_Isabel" "America/Santarem" "America/Santiago" "America/Santo_Domingo" "America/Sao_Paulo" "America/Scoresbysund" "America/Shiprock" "America/Sitka" "America/St_Barthelemy" "America/St_Johns" "America/St_Kitts" "America/St_Lucia" "America/St_Thomas" "America/St_Vincent" "America/Swift_Current" "America/Tegucigalpa" "America/Thule" "America/Thunder_Bay" "America/Tijuana" "America/Toronto" "America/Tortola" "America/Vancouver" "America/Virgin" "America/Whitehorse" "America/Winnipeg" "America/Yakutat" "America/Yellowknife" "Antarctica/Casey" "Antarctica/Davis" "Antarctica/DumontDUrville" "Antarctica/Macquarie" "Antarctica/Mawson" "Antarctica/McMurdo" "Antarctica/Palmer" "Antarctica/Rothera" "Antarctica/Syowa" "Antarctica/Troll" "Antarctica/Vostok" "Arctic/Longyearbyen" "Asia/Aden" "Asia/Almaty" "Asia/Amman" "Asia/Anadyr" "Asia/Aqtau" "Asia/Aqtobe" "Asia/Ashgabat" "Asia/Atyrau" "Asia/Baghdad" "Asia/Bahrain" "Asia/Baku" "Asia/Bangkok" "Asia/Barnaul" "Asia/Beirut" "Asia/Bishkek" "Asia/Brunei" "Asia/Chita" "Asia/Chongqing" "Asia/Colombo" "Asia/Damascus" "Asia/Dhaka" "Asia/Dili" "Asia/Dubai" "Asia/Dushanbe" "Asia/Famagusta" "Asia/Gaza" "Asia/Harbin" "Asia/Hebron" "Asia/Ho_Chi_Minh" "Asia/Hong_Kong" "Asia/Hovd" "Asia/Irkutsk" "Asia/Istanbul" "Asia/Jakarta" "Asia/Jayapura" "Asia/Jerusalem" "Asia/Kabul" "Asia/Kamchatka" "Asia/Karachi" "Asia/Kashgar" "Asia/Kathmandu" "Asia/Khandyga" "Asia/Kolkata" "Asia/Krasnoyarsk" "Asia/Kuala_Lumpur" "Asia/Kuching" "Asia/Kuwait" "Asia/Macau" "Asia/Magadan" "Asia/Makassar" "Asia/Manila" "Asia/Muscat" "Asia/Nicosia" "Asia/Novokuznetsk" "Asia/Novosibirsk" "Asia/Omsk" "Asia/Oral" "Asia/Phnom_Penh" "Asia/Pontianak" "Asia/Pyongyang" "Asia/Qatar" "Asia/Qostanay" "Asia/Qyzylorda" "Asia/Riyadh" "Asia/Sakhalin" "Asia/Samarkand" "Asia/Seoul" "Asia/Shanghai" "Asia/Singapore" "Asia/Srednekolymsk" "Asia/Taipei" "Asia/Tashkent" "Asia/Tbilisi" "Asia/Tehran" "Asia/Tel_Aviv" "Asia/Thimphu" "Asia/Tokyo" "Asia/Tomsk" "Asia/Ulaanbaatar" "Asia/Urumqi" "Asia/Ust-Nera" "Asia/Vientiane" "Asia/Vladivostok" "Asia/Yakutsk" "Asia/Yangon" "Asia/Yekaterinburg" "Asia/Yerevan" "Atlantic/Azores" "Atlantic/Bermuda" "Atlantic/Canary" "Atlantic/Cape_Verde" "Atlantic/Faroe" "Atlantic/Jan_Mayen" "Atlantic/Madeira" "Atlantic/Reykjavik" "Atlantic/South_Georgia" "Atlantic/St_Helena" "Atlantic/Stanley" "Australia/Adelaide" "Australia/Brisbane" "Australia/Broken_Hill" "Australia/Canberra" "Australia/Currie" "Australia/Darwin" "Australia/Eucla" "Australia/Hobart" "Australia/Lindeman" "Australia/Lord_Howe" "Australia/Melbourne" "Australia/Perth" "Australia/Sydney" "Australia/Yancowinna" "Etc/GMT" "Etc/GMT+0" "Etc/GMT+1" "Etc/GMT+10" "Etc/GMT+11" "Etc/GMT+12" "Etc/GMT+2" "Etc/GMT+3" "Etc/GMT+4" "Etc/GMT+5" "Etc/GMT+6" "Etc/GMT+7" "Etc/GMT+8" "Etc/GMT+9" "Etc/GMT-0" "Etc/GMT-1" "Etc/GMT-10" "Etc/GMT-11" "Etc/GMT-12" "Etc/GMT-13" "Etc/GMT-14" "Etc/GMT-2" "Etc/GMT-3" "Etc/GMT-4" "Etc/GMT-5" "Etc/GMT-6" "Etc/GMT-7" "Etc/GMT-8" "Etc/GMT-9" "Etc/GMT0" "Etc/Greenwich" "Etc/UCT" "Etc/UTC" "Etc/Universal" "Etc/Zulu" "Europe/Amsterdam" "Europe/Andorra" "Europe/Astrakhan" "Europe/Athens" "Europe/Belfast" "Europe/Belgrade" "Europe/Berlin" "Europe/Bratislava" "Europe/Brussels" "Europe/Bucharest" "Europe/Budapest" "Europe/Busingen" "Europe/Chisinau" "Europe/Copenhagen" "Europe/Dublin" "Europe/Gibraltar" "Europe/Guernsey" "Europe/Helsinki" "Europe/Isle_of_Man" "Europe/Istanbul" "Europe/Jersey" "Europe/Kaliningrad" "Europe/Kirov" "Europe/Kyiv" "Europe/Lisbon" "Europe/Ljubljana" "Europe/London" "Europe/Luxembourg" "Europe/Madrid" "Europe/Malta" "Europe/Mariehamn" "Europe/Minsk" "Europe/Monaco" "Europe/Moscow" "Europe/Nicosia" "Europe/Oslo" "Europe/Paris" "Europe/Podgorica" "Europe/Prague" "Europe/Riga" "Europe/Rome" "Europe/Samara" "Europe/San_Marino" "Europe/Sarajevo" "Europe/Saratov" "Europe/Simferopol" "Europe/Skopje" "Europe/Sofia" "Europe/Stockholm" "Europe/Tallinn" "Europe/Tirane" "Europe/Tiraspol" "Europe/Ulyanovsk" "Europe/Vaduz" "Europe/Vatican" "Europe/Vienna" "Europe/Vilnius" "Europe/Volgograd" "Europe/Warsaw" "Europe/Zagreb" "Europe/Zurich" "Factory" "GMT" "Indian/Antananarivo" "Indian/Chagos" "Indian/Christmas" "Indian/Cocos" "Indian/Comoro" "Indian/Kerguelen" "Indian/Mahe" "Indian/Maldives" "Indian/Mauritius" "Indian/Mayotte" "Indian/Reunion" "Pacific/Apia" "Pacific/Auckland" "Pacific/Bougainville" "Pacific/Chatham" "Pacific/Chuuk" "Pacific/Easter" "Pacific/Efate" "Pacific/Fakaofo" "Pacific/Fiji" "Pacific/Funafuti" "Pacific/Galapagos" "Pacific/Gambier" "Pacific/Guadalcanal" "Pacific/Guam" "Pacific/Honolulu" "Pacific/Johnston" "Pacific/Kanton" "Pacific/Kiritimati" "Pacific/Kosrae" "Pacific/Kwajalein" "Pacific/Majuro" "Pacific/Marquesas" "Pacific/Midway" "Pacific/Nauru" "Pacific/Niue" "Pacific/Norfolk" "Pacific/Noumea" "Pacific/Pago_Pago" "Pacific/Palau" "Pacific/Pitcairn" "Pacific/Pohnpei" "Pacific/Port_Moresby" "Pacific/Rarotonga" "Pacific/Saipan" "Pacific/Samoa" "Pacific/Tahiti" "Pacific/Tarawa" "Pacific/Tongatapu" "Pacific/Wake" "Pacific/Wallis" "Pacific/Yap" "UTC"

Responses

Response samples

200
403
404
422

Content type

application/json

[{"table": {"month": "2025-01",
"log_count": 3
}
},
{"table": {"month": "2025-02",
"log_count": 0
}
},
{"table": {"month": "2025-03",
"log_count": 2
}
},
{"table": {"month": "2025-04",
"log_count": 0
}
},
{"table": {"month": "2025-05",
"log_count": 0
}
},
{"table": {"month": "2025-06",
"log_count": 0
}
},
{"table": {"month": "2025-07",
"log_count": 0
}
},
{"table": {"month": "2025-08",
"log_count": 0
}
},
{"table": {"month": "2025-09",
"log_count": 0
}
},
{"table": {"month": "2025-10",
"log_count": 0
}
},
{"table": {"month": "2025-11",
"log_count": 0
}
},
{"table": {"month": "2025-12",
"log_count": 0
}
}
]

[COMMON] Symptoms

List basic symptoms

query Parameters

search_expression

string

Responses

Response samples

200
422

Content type

application/json

[ ]

[COMMON] Tasks

Create task

Authorizations:

Bearer Token

Request Body schema: multipart/form-data

circle_id required	integer
name required	string
notes	string or null
is_private	boolean
alarm_before_minutes	integer or null Alarm before minutes, max 1440
start_date	date Local start date of the series, max 2 months in the past
start_hour	string <(?-mix:^(?:[01]\d\|2[0-3]):(?:[0-5]{1}\d{1})$)> Local start hour of the event
time_zone	string Enum: "Africa/Abidjan" "Africa/Accra" "Africa/Addis_Ababa" "Africa/Algiers" "Africa/Asmara" "Africa/Bamako" "Africa/Bangui" "Africa/Banjul" "Africa/Bissau" "Africa/Blantyre" "Africa/Brazzaville" "Africa/Bujumbura" "Africa/Cairo" "Africa/Casablanca" "Africa/Ceuta" "Africa/Conakry" "Africa/Dakar" "Africa/Dar_es_Salaam" "Africa/Djibouti" "Africa/Douala" "Africa/El_Aaiun" "Africa/Freetown" "Africa/Gaborone" "Africa/Harare" "Africa/Johannesburg" "Africa/Juba" "Africa/Kampala" "Africa/Khartoum" "Africa/Kigali" "Africa/Kinshasa" "Africa/Lagos" "Africa/Libreville" "Africa/Lome" "Africa/Luanda" "Africa/Lubumbashi" "Africa/Lusaka" "Africa/Malabo" "Africa/Maputo" "Africa/Maseru" "Africa/Mbabane" "Africa/Mogadishu" "Africa/Monrovia" "Africa/Nairobi" "Africa/Ndjamena" "Africa/Niamey" "Africa/Nouakchott" "Africa/Ouagadougou" "Africa/Porto-Novo" "Africa/Sao_Tome" "Africa/Timbuktu" "Africa/Tripoli" "Africa/Tunis" "Africa/Windhoek" "America/Adak" "America/Anchorage" "America/Anguilla" "America/Antigua" "America/Araguaina" "America/Argentina/Buenos_Aires" "America/Argentina/Catamarca" "America/Argentina/Cordoba" "America/Argentina/Jujuy" "America/Argentina/La_Rioja" "America/Argentina/Mendoza" "America/Argentina/Rio_Gallegos" "America/Argentina/Salta" "America/Argentina/San_Juan" "America/Argentina/San_Luis" "America/Argentina/Tucuman" "America/Argentina/Ushuaia" "America/Aruba" "America/Asuncion" "America/Atikokan" "America/Atka" "America/Bahia" "America/Bahia_Banderas" "America/Barbados" "America/Belem" "America/Belize" "America/Blanc-Sablon" "America/Boa_Vista" "America/Bogota" "America/Boise" "America/Cambridge_Bay" "America/Campo_Grande" "America/Cancun" "America/Caracas" "America/Cayenne" "America/Cayman" "America/Chicago" "America/Chihuahua" "America/Ciudad_Juarez" "America/Coral_Harbour" "America/Costa_Rica" "America/Creston" "America/Cuiaba" "America/Curacao" "America/Danmarkshavn" "America/Dawson" "America/Dawson_Creek" "America/Denver" "America/Detroit" "America/Dominica" "America/Edmonton" "America/Eirunepe" "America/El_Salvador" "America/Ensenada" "America/Fort_Nelson" "America/Fortaleza" "America/Glace_Bay" "America/Goose_Bay" "America/Grand_Turk" "America/Grenada" "America/Guadeloupe" "America/Guatemala" "America/Guayaquil" "America/Guyana" "America/Halifax" "America/Havana" "America/Hermosillo" "America/Indiana/Indianapolis" "America/Indiana/Knox" "America/Indiana/Marengo" "America/Indiana/Petersburg" "America/Indiana/Tell_City" "America/Indiana/Vevay" "America/Indiana/Vincennes" "America/Indiana/Winamac" "America/Inuvik" "America/Iqaluit" "America/Jamaica" "America/Juneau" "America/Kentucky/Louisville" "America/Kentucky/Monticello" "America/Kralendijk" "America/La_Paz" "America/Lima" "America/Los_Angeles" "America/Lower_Princes" "America/Maceio" "America/Managua" "America/Manaus" "America/Marigot" "America/Martinique" "America/Matamoros" "America/Mazatlan" "America/Menominee" "America/Merida" "America/Metlakatla" "America/Mexico_City" "America/Miquelon" "America/Moncton" "America/Monterrey" "America/Montevideo" "America/Montreal" "America/Montserrat" "America/Nassau" "America/New_York" "America/Nipigon" "America/Nome" "America/Noronha" "America/North_Dakota/Beulah" "America/North_Dakota/Center" "America/North_Dakota/New_Salem" "America/Nuuk" "America/Ojinaga" "America/Panama" "America/Pangnirtung" "America/Paramaribo" "America/Phoenix" "America/Port-au-Prince" "America/Port_of_Spain" "America/Porto_Acre" "America/Porto_Velho" "America/Puerto_Rico" "America/Punta_Arenas" "America/Rainy_River" "America/Rankin_Inlet" "America/Recife" "America/Regina" "America/Resolute" "America/Rio_Branco" "America/Santa_Isabel" "America/Santarem" "America/Santiago" "America/Santo_Domingo" "America/Sao_Paulo" "America/Scoresbysund" "America/Shiprock" "America/Sitka" "America/St_Barthelemy" "America/St_Johns" "America/St_Kitts" "America/St_Lucia" "America/St_Thomas" "America/St_Vincent" "America/Swift_Current" "America/Tegucigalpa" "America/Thule" "America/Thunder_Bay" "America/Tijuana" "America/Toronto" "America/Tortola" "America/Vancouver" "America/Virgin" "America/Whitehorse" "America/Winnipeg" "America/Yakutat" "America/Yellowknife" "Antarctica/Casey" "Antarctica/Davis" "Antarctica/DumontDUrville" "Antarctica/Macquarie" "Antarctica/Mawson" "Antarctica/McMurdo" "Antarctica/Palmer" "Antarctica/Rothera" "Antarctica/Syowa" "Antarctica/Troll" "Antarctica/Vostok" "Arctic/Longyearbyen" "Asia/Aden" "Asia/Almaty" "Asia/Amman" "Asia/Anadyr" "Asia/Aqtau" "Asia/Aqtobe" "Asia/Ashgabat" "Asia/Atyrau" "Asia/Baghdad" "Asia/Bahrain" "Asia/Baku" "Asia/Bangkok" "Asia/Barnaul" "Asia/Beirut" "Asia/Bishkek" "Asia/Brunei" "Asia/Chita" "Asia/Chongqing" "Asia/Colombo" "Asia/Damascus" "Asia/Dhaka" "Asia/Dili" "Asia/Dubai" "Asia/Dushanbe" "Asia/Famagusta" "Asia/Gaza" "Asia/Harbin" "Asia/Hebron" "Asia/Ho_Chi_Minh" "Asia/Hong_Kong" "Asia/Hovd" "Asia/Irkutsk" "Asia/Istanbul" "Asia/Jakarta" "Asia/Jayapura" "Asia/Jerusalem" "Asia/Kabul" "Asia/Kamchatka" "Asia/Karachi" "Asia/Kashgar" "Asia/Kathmandu" "Asia/Khandyga" "Asia/Kolkata" "Asia/Krasnoyarsk" "Asia/Kuala_Lumpur" "Asia/Kuching" "Asia/Kuwait" "Asia/Macau" "Asia/Magadan" "Asia/Makassar" "Asia/Manila" "Asia/Muscat" "Asia/Nicosia" "Asia/Novokuznetsk" "Asia/Novosibirsk" "Asia/Omsk" "Asia/Oral" "Asia/Phnom_Penh" "Asia/Pontianak" "Asia/Pyongyang" "Asia/Qatar" "Asia/Qostanay" "Asia/Qyzylorda" "Asia/Riyadh" "Asia/Sakhalin" "Asia/Samarkand" "Asia/Seoul" "Asia/Shanghai" "Asia/Singapore" "Asia/Srednekolymsk" "Asia/Taipei" "Asia/Tashkent" "Asia/Tbilisi" "Asia/Tehran" "Asia/Tel_Aviv" "Asia/Thimphu" "Asia/Tokyo" "Asia/Tomsk" "Asia/Ulaanbaatar" "Asia/Urumqi" "Asia/Ust-Nera" "Asia/Vientiane" "Asia/Vladivostok" "Asia/Yakutsk" "Asia/Yangon" "Asia/Yekaterinburg" "Asia/Yerevan" "Atlantic/Azores" "Atlantic/Bermuda" "Atlantic/Canary" "Atlantic/Cape_Verde" "Atlantic/Faroe" "Atlantic/Jan_Mayen" "Atlantic/Madeira" "Atlantic/Reykjavik" "Atlantic/South_Georgia" "Atlantic/St_Helena" "Atlantic/Stanley" "Australia/Adelaide" "Australia/Brisbane" "Australia/Broken_Hill" "Australia/Canberra" "Australia/Currie" "Australia/Darwin" "Australia/Eucla" "Australia/Hobart" "Australia/Lindeman" "Australia/Lord_Howe" "Australia/Melbourne" "Australia/Perth" "Australia/Sydney" "Australia/Yancowinna" "Etc/GMT" "Etc/GMT+0" "Etc/GMT+1" "Etc/GMT+10" "Etc/GMT+11" "Etc/GMT+12" "Etc/GMT+2" "Etc/GMT+3" "Etc/GMT+4" "Etc/GMT+5" "Etc/GMT+6" "Etc/GMT+7" "Etc/GMT+8" "Etc/GMT+9" "Etc/GMT-0" "Etc/GMT-1" "Etc/GMT-10" "Etc/GMT-11" "Etc/GMT-12" "Etc/GMT-13" "Etc/GMT-14" "Etc/GMT-2" "Etc/GMT-3" "Etc/GMT-4" "Etc/GMT-5" "Etc/GMT-6" "Etc/GMT-7" "Etc/GMT-8" "Etc/GMT-9" "Etc/GMT0" "Etc/Greenwich" "Etc/UCT" "Etc/UTC" "Etc/Universal" "Etc/Zulu" "Europe/Amsterdam" "Europe/Andorra" "Europe/Astrakhan" "Europe/Athens" "Europe/Belfast" "Europe/Belgrade" "Europe/Berlin" "Europe/Bratislava" "Europe/Brussels" "Europe/Bucharest" "Europe/Budapest" "Europe/Busingen" "Europe/Chisinau" "Europe/Copenhagen" "Europe/Dublin" "Europe/Gibraltar" "Europe/Guernsey" "Europe/Helsinki" "Europe/Isle_of_Man" "Europe/Istanbul" "Europe/Jersey" "Europe/Kaliningrad" "Europe/Kirov" "Europe/Kyiv" "Europe/Lisbon" "Europe/Ljubljana" "Europe/London" "Europe/Luxembourg" "Europe/Madrid" "Europe/Malta" "Europe/Mariehamn" "Europe/Minsk" "Europe/Monaco" "Europe/Moscow" "Europe/Nicosia" "Europe/Oslo" "Europe/Paris" "Europe/Podgorica" "Europe/Prague" "Europe/Riga" "Europe/Rome" "Europe/Samara" "Europe/San_Marino" "Europe/Sarajevo" "Europe/Saratov" "Europe/Simferopol" "Europe/Skopje" "Europe/Sofia" "Europe/Stockholm" "Europe/Tallinn" "Europe/Tirane" "Europe/Tiraspol" "Europe/Ulyanovsk" "Europe/Vaduz" "Europe/Vatican" "Europe/Vienna" "Europe/Vilnius" "Europe/Volgograd" "Europe/Warsaw" "Europe/Zagreb" "Europe/Zurich" "Factory" "GMT" "Indian/Antananarivo" "Indian/Chagos" "Indian/Christmas" "Indian/Cocos" "Indian/Comoro" "Indian/Kerguelen" "Indian/Mahe" "Indian/Maldives" "Indian/Mauritius" "Indian/Mayotte" "Indian/Reunion" "Pacific/Apia" "Pacific/Auckland" "Pacific/Bougainville" "Pacific/Chatham" "Pacific/Chuuk" "Pacific/Easter" "Pacific/Efate" "Pacific/Fakaofo" "Pacific/Fiji" "Pacific/Funafuti" "Pacific/Galapagos" "Pacific/Gambier" "Pacific/Guadalcanal" "Pacific/Guam" "Pacific/Honolulu" "Pacific/Johnston" "Pacific/Kanton" "Pacific/Kiritimati" "Pacific/Kosrae" "Pacific/Kwajalein" "Pacific/Majuro" "Pacific/Marquesas" "Pacific/Midway" "Pacific/Nauru" "Pacific/Niue" "Pacific/Norfolk" "Pacific/Noumea" "Pacific/Pago_Pago" "Pacific/Palau" "Pacific/Pitcairn" "Pacific/Pohnpei" "Pacific/Port_Moresby" "Pacific/Rarotonga" "Pacific/Saipan" "Pacific/Samoa" "Pacific/Tahiti" "Pacific/Tarawa" "Pacific/Tongatapu" "Pacific/Wake" "Pacific/Wallis" "Pacific/Yap" "UTC"
assignee_id	integer
	Array of objects
help_request_id	integer or null Help request ID to create task from
vault_content_calendar_display	boolean or null Vault content calendar display toggle, setting this value to true or false will create vault task, null for regular tasks

Responses

Request samples

Payload

Content type

multipart/form-data

{
  "circle_id": 1,
  "name": "Doctor appointment",
  "notes": "Checkup with Dr. Smith",
  "is_private": false,
  "alarm_before_minutes": 5,
  "start_date": "2026-01-01",
  "start_hour": "14:00",
  "time_zone": "UTC",
  "assignee_id": 1,
  "files": [
    {
      "file": "#<ActionDispatch::Http::UploadedFile:0x00007fa8e6085b60>",
      "name": "pdf-document.pdf"
    }
  ],
  "help_request_id": 1
}

Response samples

201
401
403
404
422

Content type

application/json

{"id": 178,
"created_at": "2025-12-05T12:07:29.870360Z",
"event_type": "task",
"name": "Doctor appointment",
"notes": "Regular checkup with Dr. Smith",
"is_private": false,
"alarm_before_minutes": 5,
"is_all_day": false,
"location": null,
"periodicity_type": "one_time",
"periodicity_dow": null,
"periodicity_interval": null,
"start_date": "2025-12-05",
"end_date": "2025-12-05",
"start_hour": "14:00",
"end_hour": "14:15",
"hours": null,
"time_zone": "UTC",
"series_end_date": null,
"dosage": null,
"vital_sign_measurement_type": null,
"adl_type": null,
"assignee": {"id": 1717,
"full_name": "Gabriel Ernser Yaeko Veum",
"avatar_url": null,
"placeholder_avatar_data": {"initials": "FF",
"background_color": "#FF0000"
}
},
"vault_content_calendar_display": null,
"files": [{"id": 16,
"name": "pdf-document.pdf",
"size": 0,
"file_url": "http://minio:9000/caily-private/private_store/periodic_event_file/16/example-pdf20251205-82-b0zji3-16.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=minioadmin%2F20251205%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20251205T120729Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=ff875496cc8fb51692ce0046f30a3db76ad38ca3e8f0e9ebd9e4a857be9da509"
}
]
}

Schedule todo

Authorizations:

Bearer Token

query Parameters

circle_id required	integer
completed required	boolean
cursor	string or null <date_time> created_at of the last item that was returned previously
items_per_page	integer or null
direction	string or null
vault_content	boolean or null When true, only vault tasks are returned, when false or null, only regular tasks are returned

Responses

Response samples

200
401
403
404
422

Content type

application/json

[ ]

Remove completed tasks

Authorizations:

Bearer Token

Request Body schema: application/json
required

circle_id	integer
vault_content	boolean or null When true, only vault tasks are removed, when false or null, only regular tasks are removed

Responses

Request samples

Payload

Content type

application/json

{"circle_id": 1
}

Response samples

401
403
404
422

Content type

application/json

{"error": {"code": "unauthorized",
"details": [{"key": "_base",
"message": "Session has expired"
}
]
}
}

Update task

Authorizations:

Bearer Token

path Parameters

id

required

integer

Request Body schema: application/json

name required	string
notes required	string or null
is_private required	boolean can be changed only by creator
start_date required	string or null <date> Local start date of the series, max 5 years in the past, one of time params, required when any of time params are changed
start_hour required	string or null <(?-mix:^(?:[01]\d\|2[0-3]):(?:[0-5]{1}\d{1})$)> Local start hour of the event, one of time params, required when any of time params are changed, null for all day events
alarm_before_minutes required	integer or null Alarm before minutes, max 1440
assignee_id required	integer or null
vault_content_calendar_display	boolean or null Vault content calendar display toggle, vault tasks can be converted to regular tasks and vice versa

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"notes": "string",
"is_private": true,
"start_date": "2019-08-24",
"start_hour": "string",
"alarm_before_minutes": 0,
"assignee_id": 0,
"vault_content_calendar_display": true
}

Response samples

200
401
403
404
422

Content type

application/json

{"id": 199,
"created_at": "2025-12-05T12:07:31.146272Z",
"event_type": "task",
"name": "quidem",
"notes": "At dolore dolores velit.",
"is_private": false,
"alarm_before_minutes": null,
"is_all_day": false,
"location": null,
"periodicity_type": "one_time",
"periodicity_dow": null,
"periodicity_interval": "daily",
"start_date": "2025-12-05",
"end_date": "2025-12-05",
"start_hour": "10:00",
"end_hour": "11:00",
"hours": null,
"time_zone": "UTC",
"series_end_date": null,
"dosage": null,
"vital_sign_measurement_type": null,
"adl_type": null,
"assignee": null,
"vault_content_calendar_display": null,
"files": [ ]
}

[COMMON] Vault tasks

Create vault task

Authorizations:

Bearer Token

Request Body schema: multipart/form-data

circle_id required	integer
name required	string
notes	string or null
is_private	boolean
assignee_id	integer
	Array of objects
vault_content_calendar_display required	boolean Vault content calendar display toggle

Responses

Request samples

Payload

Content type

multipart/form-data

{
  "circle_id": 1,
  "name": "Doctor appointment",
  "notes": "Checkup with Dr. Smith",
  "is_private": false,
  "assignee_id": 1,
  "files": [
    {
      "file": "#<ActionDispatch::Http::UploadedFile:0x00007fa8ec2e7498>",
      "name": "pdf-document.pdf"
    }
  ],
  "vault_content_calendar_display": true
}

Response samples

201
401
403
404
422

Content type

application/json

{"id": 210,
"created_at": "2025-12-05T12:07:31.712734Z",
"event_type": "task",
"name": "Doctor appointment",
"notes": "Regular checkup with Dr. Smith",
"is_private": false,
"alarm_before_minutes": null,
"is_all_day": false,
"location": null,
"periodicity_type": "one_time",
"periodicity_dow": null,
"periodicity_interval": null,
"start_date": null,
"end_date": null,
"start_hour": null,
"end_hour": null,
"hours": null,
"time_zone": "UTC",
"series_end_date": null,
"dosage": null,
"vital_sign_measurement_type": null,
"adl_type": null,
"assignee": {"id": 1789,
"full_name": "Cathy Fritsch Zena Cruickshank",
"avatar_url": null,
"placeholder_avatar_data": {"initials": "FF",
"background_color": "#FF0000"
}
},
"vault_content_calendar_display": true,
"files": [{"id": 18,
"name": "pdf-document.pdf",
"size": 0,
"file_url": "http://minio:9000/caily-private/private_store/periodic_event_file/18/example-pdf20251205-82-gzkypp-18.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=minioadmin%2F20251205%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20251205T120731Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=67635fec6508d01c7c66c497666bf308be8f9d041d7b190acc736497cc40dc2e"
}
]
}

Destroy vault task

Authorizations:

Bearer Token

path Parameters

id

required

integer

Responses

Response samples

401
403
404
422

Content type

application/json

{"error": {"code": "unauthorized",
"details": [{"key": "_base",
"message": "Session has expired"
}
]
}
}

Show vault task

Authorizations:

Bearer Token

path Parameters

id

required

integer

Responses

Response samples

200
401
403
404
422

Content type

application/json

{"id": 236,
"created_at": "2025-12-05T12:07:33.227630Z",
"event_type": "event",
"name": "et",
"notes": "Tenetur reiciendis reprehenderit laudantium.",
"is_private": false,
"alarm_before_minutes": null,
"is_all_day": false,
"location": null,
"periodicity_type": "interval",
"periodicity_dow": null,
"periodicity_interval": "daily",
"start_date": "2025-12-05",
"end_date": "2025-12-05",
"start_hour": "10:00",
"end_hour": "11:00",
"hours": null,
"time_zone": "UTC",
"series_end_date": null,
"dosage": null,
"vital_sign_measurement_type": null,
"adl_type": null,
"assignee": null,
"vault_content_calendar_display": null,
"files": [ ]
}

Update vault task

Authorizations:

Bearer Token

path Parameters

id

required

integer

Request Body schema: application/json

name required	string
notes required	string or null
is_private required	boolean can be changed only by creator
assignee_id required	integer or null
vault_content_calendar_display required	boolean Vault content calendar display toggle

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"notes": "string",
"is_private": true,
"assignee_id": 0,
"vault_content_calendar_display": true
}

Response samples

200
401
403
404
422

Content type

application/json

{"id": 242,
"created_at": "2025-12-05T12:07:33.467803Z",
"event_type": "task",
"name": "New name",
"notes": "New notes",
"is_private": false,
"alarm_before_minutes": null,
"is_all_day": false,
"location": null,
"periodicity_type": "one_time",
"periodicity_dow": null,
"periodicity_interval": "daily",
"start_date": "2025-12-05",
"end_date": "2025-12-05",
"start_hour": "10:00",
"end_hour": "11:00",
"hours": null,
"time_zone": "UTC",
"series_end_date": null,
"dosage": null,
"vital_sign_measurement_type": null,
"adl_type": null,
"assignee": null,
"vault_content_calendar_display": true,
"files": [ ]
}

Vault schedule todo

Authorizations:

Bearer Token

query Parameters

circle_id required	integer
completed required	boolean
cursor	string or null <date_time> created_at of the last item that was returned previously
items_per_page	integer or null
direction	string or null

Responses

Response samples

200
401
403
404
422

Content type

application/json

[{"periodic_event_id": 218,
"calendar_entry_id": 240,
"created_at": "2025-12-05T12:07:32.667382Z",
"name": "nesciunt",
"is_private": false,
"has_note": true,
"has_files": false,
"assignee": null,
"is_vault_task": true
},
{"periodic_event_id": 219,
"calendar_entry_id": 241,
"created_at": "2025-12-05T12:07:32.675331Z",
"name": "quia",
"is_private": false,
"has_note": true,
"has_files": false,
"assignee": null,
"is_vault_task": true
}
]

Remove completed vault tasks

Authorizations:

Bearer Token

Request Body schema: application/json
required

circle_id	integer
vault_content	boolean or null When true, only vault tasks are removed, when false or null, only regular tasks are removed

Responses

Request samples

Payload

Content type

application/json

{"circle_id": 1
}

Response samples

401
403
404
422

Content type

application/json

{"error": {"code": "unauthorized",
"details": [{"key": "_base",
"message": "Session has expired"
}
]
}
}

[COMMON] Vault Files

Create vault file

Authorizations:

Bearer Token

Request Body schema: multipart/form-data

vault_folder_id	integer
file required	string <binary>
name	string
circle_id required	integer

Responses

Response samples

201
403
404
422

Content type

application/json

{"id": 1,
"name": "name.pdf",
"size": 0,
"file_url": "http://minio:9000/caily-private/private_store/vault_file/1/example-pdf20251205-82-eutvuk-1.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=minioadmin%2F20251205%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20251205T120734Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=516b5289c9b34a6e21fc866e175053ee1fb750d2a64cfb737e2129ee178c3445",
"created_at": "2025-12-05T12:07:34.375582Z",
"vault_folder_name": null,
"vault_form_name": null
}

Delete vault file

Authorizations:

Bearer Token

path Parameters

id

required

integer

Responses

Response samples

403
404
422

Content type

application/json

{"error": {"code": "authorize",
"details": [{"key": "_base",
"message": "You don't have permission to access this space. Please contact your Circle Admin to update your permissions"
}
]
}
}

Get circle's vault files

Authorizations:

Bearer Token

path Parameters

id

required

integer

query Parameters

folder_id	integer Filter files by folder ID
search_expression	string Search vault files by file name
cursor	integer
items_per_page	integer
direction	string

Responses

Response samples

200
401
404
422

Content type

application/json

[{"id": 8,
"name": "example_file.png",
"size": 177392,
"file_url": "http://minio:9000/caily-private/private_store/fb48394bfa912b2e40e757865ec5b452.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=minioadmin%2F20251205%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20251205T120735Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=2d8146eaa9827744290dcebfdfd0622c26c45ff3b2704f95a0a24a529355c943",
"created_at": "2025-12-05T12:07:35.104177Z",
"vault_folder_name": null,
"vault_form_name": null
}
]

[COMMON] Vault Form Responses

Create vault form response

Authorizations:

Bearer Token

path Parameters

circle_id

required

integer

Circle ID

Request Body schema: application/json

vault_form_id required	integer ID of the vault form
required	object Structured content of the vault form response

Responses

Request samples

Payload

Content type

application/json

{"vault_form_id": 0,
"content": {"subcategories": [{"id": "string",
"name": "string",
"description": "string",
"can_duplicate": true,
"question_groups": [{"id": "string",
"name": "string",
"questions": [{"id": "string",
"label": "string",
"type": "string",
"description": "string",
"answer": "string"
}
]
}
]
}
]
}
}

Response samples

201
401
403
404
422

Content type

application/json

{"id": 1,
"content": {"subcategories": [{"id": "personal_medical_history",
"name": "Personal Medical History",
"description": "The \"Personal Medical History\" section captures essential details...",
"can_duplicate": true,
"question_groups": [{"id": "conditions",
"name": "Conditions",
"questions": [{"id": "medical_history_summary",
"label": "Medical History Summary",
"type": "text",
"description": "What are your current or past medical conditions?",
"answer": "No significant conditions reported."
}
]
}
]
}
]
},
"vault_form_name": "Healthcare Records",
"vault_form_description": "Healthcare Records"
}

Update vault form response

Authorizations:

Bearer Token

path Parameters

circle_id

required

integer

Circle ID

query Parameters

vault_form_id

required

integer

ID of the vault form

Responses

Response samples

200
401
403
404
422

Content type

application/json

{"id": 3,
"content": {"subcategories": [{"id": "medical_information",
"name": "Medical Information",
"description": "Basic medical details",
"can_duplicate": false,
"question_groups": [{"id": "history",
"name": "Medical History",
"questions": [{"id": "medical_history",
"label": "Medical History",
"type": "text",
"description": "Enter your medical history",
"answer": "No"
},
{"id": "allergies",
"label": "Allergies",
"type": "text",
"description": "Enter any allergies",
"answer": "None"
}
]
}
]
}
]
},
"vault_form_name": "Healthcare Records",
"vault_form_description": "Healthcare Records"
}

Update vault form response

Authorizations:

Bearer Token

path Parameters

circle_id

required

integer

Circle ID

Request Body schema: application/json

vault_form_id required	integer ID of the vault form
required	object Structured content of the vault form response

Responses

Request samples

Payload

Content type

application/json

{"vault_form_id": 0,
"content": {"subcategories": [{"id": "string",
"name": "string",
"description": "string",
"can_duplicate": true,
"question_groups": [{"id": "string",
"name": "string",
"questions": [{"id": "string",
"label": "string",
"type": "string",
"description": "string",
"answer": "string"
}
]
}
]
}
]
}
}

Response samples

200
401
403
404
422

Content type

application/json

{"id": 11,
"content": {"subcategories": [{"id": "personal_medical_history",
"name": "Personal Medical History",
"description": "The \"Personal Medical History\" section captures essential details...",
"can_duplicate": true,
"question_groups": [{"id": "conditions",
"name": "Conditions",
"questions": [{"id": "medical_history_summary",
"label": "Medical History Summary",
"type": "text",
"description": "What are your current or past medical conditions?",
"answer": "No significant conditions reported."
}
]
}
]
}
]
},
"vault_form_name": "Healthcare Records",
"vault_form_description": "Healthcare Records"
}

[COMMON] Vault Forms

Get single vault form

Authorizations:

Bearer Token

path Parameters

circle_id required	integer Circle ID
id required	integer Vault Form ID

Responses

Response samples

200
401
403
404
422

Content type

application/json

{"name": null,
"description": null,
"category_key": "last_wishes_and_estate_planning",
"subcategories": [{"id": "will_testament",
"name": "Will & Testament",
"description": "The \"Will & Testament\" section consolidates key information about your will, including executors, beneficiaries, and specific requests. It ensures your wishes are clearly documented and accessible for estate planning and execution.",
"can_duplicate": false,
"question_groups": [{"id": "executor_information",
"name": "Executor Information",
"questions": [{"id": "executor_name",
"label": "Name of the Executor",
"type": "text",
"description": "Who is the executor of your will? (Provide name, contact information, and relationship.)"
},
{"id": "alternate_executor",
"label": "Alternate Executor",
"type": "text",
"description": "Is there an alternate executor?"
}
]
},
{"id": "beneficiary_information",
"name": "Beneficiary Information",
"questions": [{"id": "beneficiary_details",
"label": "Beneficiary Details",
"type": "text",
"description": "Who are the beneficiaries listed in your will? (Include names, relationships, and allocations.)"
}
]
},
{"id": "specific_requests",
"name": "Specific Requests",
"questions": [{"id": "bequest_details",
"label": "Specific Requests",
"type": "text",
"description": "Are there specific items or assets left to certain individuals?"
}
]
},
{"id": "will_location",
"name": "Will Location",
"questions": [{"id": "original_document_storage",
"label": "Original Document Storage",
"type": "text",
"description": "Where is the original copy of your will stored?"
}
]
},
{"id": "attachments",
"name": "Attachments",
"questions": [{"id": "will_attachments",
"label": "Attachments",
"type": "file",
"description": "Copy of the will, executor instructions, and beneficiary contact details."
}
]
},
{"id": "digital_assets",
"name": "Digital Assets",
"questions": [{"id": "digital_asset_list",
"label": "Digital Asset",
"type": "text",
"description": "What digital assets do you have? (Social media accounts, crypto, NFTs, photos, videos, software, etc.)"
}
]
}
]
},
{"id": "trusts",
"name": "Trusts",
"description": "The \"Trusts\" section organizes critical details about any trusts you've established, including trustees, beneficiaries, and assets held. It ensures clear documentation for asset management, tax planning, and beneficiary distributions.",
"can_duplicate": true,
"question_groups": [{"id": "trust_name",
"name": "Trust Name",
"questions": [{"id": "name_of_trust",
"label": "Name of the Trust",
"type": "text",
"description": "What is the name of the trust? (e.g., Family Living Trust)"
}
]
},
{"id": "trustee_information",
"name": "Trustee Information",
"questions": [{"id": "trustee_details",
"label": "Trustee Details",
"type": "text",
"description": "Who is the trustee? (Provide name, contact details, and relationship.)"
},
{"id": "successor_trustee",
"label": "Successor Trustee Information",
"type": "text",
"description": "Is there a successor trustee?"
}
]
},
{"id": "trust_purpose",
"name": "Trust Purpose",
"questions": [{"id": "purpose_details",
"label": "Trust Purpose",
"type": "text",
"description": "What is the purpose of the trust? (e.g., asset protection, tax benefits, care for dependents)"
}
]
},
{"id": "assets_in_trust",
"name": "Assets in the Trust",
"questions": [{"id": "trust_assets",
"label": "Assets in the Trust",
"type": "text",
"description": "What assets are included in the trust? (e.g., properties, financial accounts)"
}
]
},
{"id": "beneficiary_information",
"name": "Beneficiary Information",
"questions": [{"id": "trust_beneficiary_details",
"label": "Trust Beneficiary Details",
"type": "text",
"description": "Who are the beneficiaries of the trust? (Include names and allocation percentages.)"
}
]
},
{"id": "attachments",
"name": "Attachments",
"questions": [{"id": "trust_attachments",
"label": "Attachments",
"type": "file",
"description": "Trust agreement, trustee instructions, and beneficiary contact details."
}
]
}
]
},
{"id": "power_of_attorney",
"name": "Power of Attorney",
"description": "The \"Power of Attorney\" section captures details about individuals authorized to make legal or financial decisions on your behalf. It ensures clear documentation of their scope of authority and effective dates for seamless management during critical situations.",
"can_duplicate": true,
"question_groups": [{"id": "appointed_individuals",
"name": "Appointed Individual(s)",
"questions": [{"id": "poa_designation",
"label": "Power of Attorney Designation",
"type": "text",
"description": "Who is your power of attorney? (Provide name, contact details, and relationship.)\nIs there an alternate power of attorney?"
}
]
},
{"id": "scope_of_authority",
"name": "Scope of Authority",
"questions": [{"id": "authority_limits",
"label": "Power of Attorney Authority Limits",
"type": "text",
"description": "Does the power of attorney have broad authority or limited authority? (Specify.)"
}
]
},
{"id": "effective_dates",
"name": "Effective Dates",
"questions": [{"id": "date_details",
"label": "Effective Dates",
"type": "text",
"description": "When does the power of attorney take effect? (e.g., immediately, upon incapacitation)"
}
]
},
{"id": "attachments",
"name": "Attachments",
"questions": [{"id": "poa_attachments",
"label": "Attachments",
"type": "file",
"description": "Power of attorney document, instructions for the appointed individual."
}
]
}
]
},
{"id": "funeral_preferences",
"name": "Funeral Preferences",
"description": "The \"Funeral Preferences\" section outlines your wishes for end-of-life services, including burial or cremation, service details, and specific requests. It ensures your preferences are documented and accessible for your loved ones during a difficult time.",
"can_duplicate": false,
"question_groups": [{"id": "type_of_service",
"name": "Type of Service",
"questions": [{"id": "burial_cremation",
"label": "Burial or Cremation",
"type": "text",
"description": "Do you prefer burial or cremation?"
},
{"id": "service_preference",
"label": "Service Preference",
"type": "text",
"description": "Would you like a traditional service, a celebration of life, or no service?"
},
{"id": "ash_disposition",
"label": "Ash Disposition",
"type": "text",
"description": "If cremation, what do you want to do with your ashes? (Scattered, planted, distributed between friends or family members) What urn would you like?"
},
{"id": "urn_selection",
"label": "Urn Selection",
"type": "text",
"description": "What urn would you like?"
}
]
},
{"id": "specific_requests",
"name": "Specific Requests",
"questions": [{"id": "service_details",
"label": "Specific Requests",
"type": "text",
"description": "Are there specific details you'd like included? (e.g., readings, music, venue)"
}
]
},
{"id": "funeral_home",
"name": "Funeral Home",
"questions": [{"id": "funeral_home_details",
"label": "Funeral Home details",
"type": "text",
"description": "Have you pre-selected a funeral home? (Provide contact details if applicable.)"
}
]
},
{"id": "costs_and_payments",
"name": "Costs and Payments",
"questions": [{"id": "prepaid_arrangements",
"label": "Prepaid Arrangements",
"type": "text",
"description": "Have you prepaid for any funeral arrangements?"
}
]
},
{"id": "attachments",
"name": "Attachments",
"questions": [{"id": "funeral_attachments",
"label": "Attachments",
"type": "file",
"description": "Pre-need agreements, funeral preferences document, and any prepaid receipts."
}
]
}
]
},
{"id": "organ_donation",
"name": "Organ Donation",
"description": "The \"Organ Donation\" section records your preferences for organ and tissue donation, including registration details and specific instructions. It ensures your wishes are honored and accessible in critical moments.",
"can_duplicate": true,
"question_groups": [{"id": "registration_status",
"name": "Registration Status",
"questions": [{"id": "donor_registration",
"label": "Organ Donor Registration",
"type": "text",
"description": "Are you registered as an organ donor? (If yes, include registration details.)"
}
]
},
{"id": "donation_preferences",
"name": "Donation Preferences",
"questions": [{"id": "organ_preferences",
"label": "Donation Preferences",
"type": "text",
"description": "Are there specific organs or tissues you wish to donate?"
},
{"id": "donation_limitations",
"label": "Donation Limitations",
"type": "text",
"description": "Are there restrictions on organ donation?"
}
]
},
{"id": "attachments",
"name": "Attachments:",
"questions": [{"id": "organ_donation_attachments",
"label": "Attachments",
"type": "file",
"description": "Organ donor card, registration confirmation, and related documents."
}
]
}
]
},
{"id": "legacy_planning",
"name": "Legacy Planning",
"description": "Planning for the future is a way to ensure your values, wishes, and legacy are honored. Let's take this step together.",
"can_duplicate": false,
"question_groups": [{"id": "personal_legacy_goals",
"name": "Personal Legacy Goals",
"questions": [{"id": "legacy_goals",
"label": "Personal Legacy Goals",
"type": "text",
"description": "What's most important to you when it comes to your legacy or how you'd like to be remembered?\n\nExample Answer: \"I want my family to remember me as someone who loved them deeply and always supported them."
}
]
},
{"id": "comfort_level_assessment",
"name": "Comfort Level Assessment",
"questions": [{"id": "comfort_assessment",
"label": "Comfort Level Assessment",
"type": "text",
"description": "How do you feel about starting this process? It's okay to feel nervous—it's a big step.\n\nExample Answer: \"I'm a little overwhelmed, but I know it's important."
},
{"id": "messages_keepsakes",
"label": "Messages and Keepsakes",
"type": "text",
"description": "Would you like to leave messages or keepsakes for loved ones?\n\nYes, I want to write letters to my grandchildren for them to read when they're older."
},
{"id": "sharing_plans",
"label": "Sharing Plans",
"type": "text",
"description": "Who should know about your plans, and how would you like to share them?\n\nExample Answer: \"I'd like to talk to my family at our next gathering and share a copy of my wishes with my doctor."
},
{"id": "revisit_frequency",
"label": "Revisit Frequency",
"type": "text",
"description": "How often would you like to revisit your plans to make sure they still feel right?\n\nExample Answer: \"Maybe once a year or whenever there's a big change in my health."
}
]
}
]
},
{"id": "other",
"name": "Other",
"description": "Is there anything else you'd like to add to this category?",
"can_duplicate": false,
"question_groups": [{"id": "other",
"name": "Other",
"questions": [{"id": "estate_planning_checklist",
"label": "Estate Planning Checklist:",
"type": "file",
"description": "Comprehensive summary of all estate planning documents."
},
{"id": "financial_asset_inventory",
"label": "Financial and Asset Inventory:",
"type": "file",
"description": "List of all assets to be included in the estate plan."
},
{"id": "legal_advisor_contact",
"label": "Legal Advisor Contact Information:",
"type": "text",
"description": "Name and contact information for your attorney or estate planner."
}
]
}
]
}
]
}

[COMMON] Vault Permissions

Update vault permissions

Authorizations:

Bearer Token

path Parameters

circle_id

required

integer

Request Body schema: application/json

vault_form_id	integer
vault_folder_id	integer
vault_feature	string Enum: "vault_forms" "vault_folders"
	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"vault_form_id": 0,
"vault_folder_id": 0,
"vault_feature": "vault_forms",
"permissions": [{"user_id": 0,
"permission_type": "string"
}
]
}

Response samples

401
403
404
422

Content type

application/json

{"error": {"code": "unauthorized",
"details": [{"key": "_base",
"message": "Session has expired"
}
]
}
}

[COMMON] Vital Signs

Create vital sign

Authorizations:

Bearer Token

path Parameters

circle_id

required

integer

Request Body schema: application/json

measurement_time required	date_time
vital_sign_type required	string Enum: "temperature" "heart_rate" "respiratory_rate" "blood_pressure" "oxygen_saturation" "pain_level" "glucose_level" "weight" "height"
measurement_1 required	number
measurement_2	number Provide this only if vital_sign_type is blood_pressure
calendar_entry_id	integer or null Vital sign calendar entry id, when passed calendar entry is marked as completed

Responses

Request samples

Payload

Content type

application/json

{"measurement_time": null,
"vital_sign_type": "temperature",
"measurement_1": 0,
"measurement_2": 0,
"calendar_entry_id": 0
}

Response samples

201
401
403
404
422

Content type

application/json

{"id": 13,
"measurement_time": "2025-12-05T12:07:38.670000Z",
"measurement_1_imperial": 70,
"measurement_1_metric": 177.8,
"measurement_2": null
}

Destroy Vital Sign

Authorizations:

Bearer Token

path Parameters

id

required

integer

Vital Sign ID

Responses

Response samples

401
403
404
422

Content type

application/json

{"error": {"code": "unauthorized",
"details": [{"key": "_base",
"message": "Session has expired"
}
]
}
}

Show vital sign

Authorizations:

Bearer Token

path Parameters

id

required

integer

Responses

Response samples

200
401
403
404
422

Content type

application/json

{"id": 21,
"measurement_time": "2025-12-05T12:07:39.339064Z",
"measurement_1_imperial": 36,
"measurement_1_metric": 38,
"measurement_2": null
}

Update vital sign

Authorizations:

Bearer Token

path Parameters

id

required

integer

Request Body schema: application/json

measurement_time	date_time
measurement_1	number
measurement_2	number or null Provide this only if vital_sign_type is blood_pressure

Responses

Request samples

Payload

Content type

application/json

{"measurement_time": null,
"measurement_1": 0,
"measurement_2": 0
}

Response samples

200
401
403
404
422

Content type

application/json

{"id": 27,
"measurement_time": "2025-12-05T12:07:39.548000Z",
"measurement_1_imperial": 70,
"measurement_1_metric": 70,
"measurement_2": null
}

[INTERNAL] Consents

Upsert consent

This endpoint is authorized by internal API secret sent as Bearer token.

Authorizations:

Bearer Token

Request Body schema: multipart/form-data

consent_type	string Enum: "privacy_policy" "terms_and_conditions" "services_accessibility" "consumer_health_data_privacy" "auto_renewal_subscription_terms" "client_agreement"
document	string <binary> PDF file
effective_date	string <date>
scope	string Enum: "b2c" "b2b"

Responses

Request samples

Payload

Content type

multipart/form-data

{
  "consent_type": "privacy_policy",
  "document": "#<ActionDispatch::Http::UploadedFile:0x00007fa8dcbd42f0>",
  "scope": "b2c"
}

Response samples

200
401
422

Content type

application/json

{"id": 5,
"consent_type": "privacy_policy",
"document_url": "http://minio:9000/caily-public/public_store/consent/5/example-pdf20251205-82-txw8ox-1764936459774-5.pdf",
"version": 1
}

[INTERNAL] Feature Flags

Create feature flag

Authorizations:

Bearer Token

Request Body schema: application/json

name required	string Unique name for the feature flag
flag_type required	string Enum: "boolean" "multi" Type of feature flag
value required	string Current value of the feature flag (alphanumeric characters and underscores only)
allowed_values	Array of strings Allowed values for multi type flags (each value must contain only alphanumeric characters and underscores, required for multi, ignored for boolean)

Responses

Request samples

Payload

Content type

application/json

Example

creates a boolean feature flag

{"name": "enable_dark_mode",
"flag_type": "boolean",
"value": "true"
}

Response samples

201
401
422

Content type

application/json

{"name": "test_feature",
"flag_type": "boolean",
"value": "true",
"allowed_values": ["true",
"false"
]
}

Update feature flag

Authorizations:

Bearer Token

path Parameters

feature_flag_name

required

string

Feature Flag Name

Request Body schema: application/json

value	string New value for the feature flag (alphanumeric characters and underscores only)
allowed_values	Array of strings New allowed values for the feature flag (each value must contain only alphanumeric characters and underscores). Note: Cannot be updated for boolean feature flags. When updating allowed_values, any existing user overrides with values not in the new allowed_values will be automatically removed.

Responses

Request samples

Payload

Content type

application/json

Example

updates feature flag value

{"value": "false"
}

Response samples

200
401
404
422

Content type

application/json

{"name": "test_feature",
"flag_type": "multi",
"value": "option2",
"allowed_values": ["option1",
"option2",
"option3"
]
}

[MOBILE] Subscription Plans

List subscription plans

Authorizations:

Bearer Token

Responses

Response samples

200
401

Content type

application/json

[{"id": 738,
"name": "Package 22",
"key": "package_22",
"description": "Package 738 description",
"feature_groups": [{"name": "Health",
"key": "health",
"icon_url": "https://assets.example.com/assets/health-2b31489dbf7e2cf9d8e0507b886708c7362876215038f16de4d1446553b12f86.svg"
},
{"name": "Vault",
"key": "vault",
"icon_url": "https://assets.example.com/assets/vault-0b625efa840333fef7a22e73f38496624a41c4eaa4f73ff199f42082bb7121f4.svg"
}
],
"paywall_features": [ ],
"product_lookup_keys": ["9467633820",
"2029796782"
]
},
{"id": 739,
"name": "Package 23",
"key": "package_23",
"description": "Package 739 description",
"feature_groups": [{"name": "Health",
"key": "health",
"icon_url": "https://assets.example.com/assets/health-2b31489dbf7e2cf9d8e0507b886708c7362876215038f16de4d1446553b12f86.svg"
},
{"name": "Vault",
"key": "vault",
"icon_url": "https://assets.example.com/assets/vault-0b625efa840333fef7a22e73f38496624a41c4eaa4f73ff199f42082bb7121f4.svg"
}
],
"paywall_features": [ ],
"product_lookup_keys": ["1081752637",
"8198416073"
]
},
{"id": 740,
"name": "Package 24",
"key": "package_24",
"description": "Package 740 description",
"feature_groups": [{"name": "Health",
"key": "health",
"icon_url": "https://assets.example.com/assets/health-2b31489dbf7e2cf9d8e0507b886708c7362876215038f16de4d1446553b12f86.svg"
},
{"name": "Vault",
"key": "vault",
"icon_url": "https://assets.example.com/assets/vault-0b625efa840333fef7a22e73f38496624a41c4eaa4f73ff199f42082bb7121f4.svg"
}
],
"paywall_features": [ ],
"product_lookup_keys": ["6714660339",
"9556044356"
]
}
]

[WEB] Stripe

Create checkout session

Authorizations:

Bearer Token

Request Body schema: application/json
required

stripe_price_id	string
success_url	string
cancel_url	string
trial_enabled	boolean Whether to enable trial period, required when feature flag b2c_subscription_trials is set to stores. Not allowed when feature flag b2c_subscription_trials is set to internal

Responses

Request samples

Payload

Content type

application/json

{"stripe_price_id": "string",
"success_url": "string",
"cancel_url": "string",
"trial_enabled": true
}

Response samples

201
401
422

Content type

application/json

{"id": "checkout_session_id",
"url": "https://checkout.stripe.com/c/checkout/test_session_id"
}

[WEB] Subscription Plans

List subscription plans

Authorizations:

Bearer Token

Responses

Response samples

200
401

Content type

application/json

[{"id": 744,
"name": "Package 28",
"key": "package_28",
"description": "Package 744 description",
"feature_groups": [{"name": "Health",
"key": "health",
"icon_url": "https://assets.example.com/assets/health-2b31489dbf7e2cf9d8e0507b886708c7362876215038f16de4d1446553b12f86.svg"
},
{"name": "Vault",
"key": "vault",
"icon_url": "https://assets.example.com/assets/vault-0b625efa840333fef7a22e73f38496624a41c4eaa4f73ff199f42082bb7121f4.svg"
}
],
"paywall_features": [ ],
"prices": [{"id": "price_1",
"amount": 1000,
"currency": "USD",
"interval": "month"
}
]
}
]

[WEBHOOKS] Revenue Cat

Revenue Cat Webhook

Request Body schema: application/json

event

object

Responses

Request samples

Payload

Content type

application/json

{"event": { }
}

Response samples

200

Content type

application/json

Example

Webhook received

{"message": "Webhook received"
}

[WEBHOOKS] Stripe

Stripe B2B Subscriptions Webhook

Request Body schema: application/json

id	string
object	string
api_version	string
created	integer
data	object
livemode	boolean
pending_webhooks	integer
request	object
type	string

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"object": "string",
"api_version": "string",
"created": 0,
"data": { },
"livemode": true,
"pending_webhooks": 0,
"request": { },
"type": "string"
}

Stripe Customer Deleted Webhook

Request Body schema: application/json

id	string
object	string
api_version	string
created	integer
data	object
livemode	boolean
pending_webhooks	integer
request	object
type	string

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"object": "string",
"api_version": "string",
"created": 0,
"data": { },
"livemode": true,
"pending_webhooks": 0,
"request": { },
"type": "string"
}