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%2F20260102%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20260102T130212Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=c1c488e8ae2fa57a93a10f6f190f5c794b9860f2b6b8d9ed979ac1f5bfc6f69c",
"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%2F20260102%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20260102T130212Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=c1c488e8ae2fa57a93a10f6f190f5c794b9860f2b6b8d9ed979ac1f5bfc6f69c",
"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": "2026-01-01T13:02:16.236202Z",
"updated_at": "2026-01-02T13:02:16.242548Z",
"status": "active"
},
{"id": 29,
"first_name": "Jane",
"last_name": "Smith",
"email": "jane.smith@test.com",
"department": "Finance Accounting",
"created_at": "2025-12-31T13:02:16.232889Z",
"updated_at": "2026-01-02T13:02:16.234008Z",
"status": "pending"
},
{"id": 28,
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@test.com",
"department": "Human Resources",
"created_at": "2025-12-30T13:02:16.227040Z",
"updated_at": "2026-01-02T13:02:16.228634Z",
"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": "2026-01-02T13:02:16.593615Z",
"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": "2026-01-02T13:02:18.022916Z",
"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-31T13:02:18.019759Z",
"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": "PZhhvn0tJ1xdZ6FWUrqLg2MK4f5NbUI5mGtgDvTdGtA",
"token_type": "Bearer",
"expires_in": 900,
"created_at": 1767358938,
"refresh_token": "qt_x0gWMNkPI0ayp5S50soCWq_NH1uF5WfcKkF5JcC4",
"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": "2026-01-02T13:02:19.461082Z",
"employees_count": 0,
"address": {"id": 1,
"street_name": "Shelly Flat",
"city": "Jameyport",
"state_province": "Michigan",
"zip_code": "96894",
"created_at": "2026-01-02T13:02:19.509299Z",
"updated_at": "2026-01-02T13:02:19.509299Z"
},
"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": "zena@bins-murazik.example",
"primary_contact_name": null,
"created_at": "2026-01-02T13:02:19.795533Z",
"employees_count": 0,
"address": {"id": 7,
"street_name": "123 Market Street",
"city": "San Francisco",
"state_province": "California",
"zip_code": "94103",
"created_at": "2026-01-02T13:02:19.820951Z",
"updated_at": "2026-01-02T13:02:19.820951Z"
},
"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": "Chau",
"last_name": "Vandervort",
"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": "O0VCKqHNw-tnqnRrvVQSBSD7EnvSGCudvyxqMZkgEzk",
"token_type": "Bearer",
"expires_in": 900,
"refresh_token": "QjBZMJGVeTzawz_VqQ0Zo7k5lvOn2G6GMYTMvEmuxxk",
"scope": "b2b",
"created_at": 1728561600,
"user": {"id": 155,
"first_name": "Harry",
"last_name": "Rogahn",
"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-02-02T13:02:22.250456Z",
"cancel_at": null,
"created_at": "2026-01-02T13:02:22.250907Z",
"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-02-02T13:02:22.462391Z",
"cancel_at": null,
"created_at": "2026-01-02T13:02:22.462699Z",
"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%2F20260102%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20260102T130222Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=406b2c232d5e827bd0fab050b1a175c090a3332ce1fdb2e0528c71476de58e9d"
},
{"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%2F20260102%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20260102T130222Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=406b2c232d5e827bd0fab050b1a175c090a3332ce1fdb2e0528c71476de58e9d"
},
{"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%2F20260102%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20260102T130222Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=406b2c232d5e827bd0fab050b1a175c090a3332ce1fdb2e0528c71476de58e9d"
},
{"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%2F20260102%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20260102T130222Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=406b2c232d5e827bd0fab050b1a175c090a3332ce1fdb2e0528c71476de58e9d"
}
],
"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": "2026-01-02T13:02:23.712830Z",
"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-31T13:02:23.709115Z",
"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": "F0zqzyeoN7vFWbNCXo4f5ufNMapDwWm4mU3CRc6-iPQ",
"token_type": "Bearer",
"expires_in": 900,
"created_at": 1767358944,
"refresh_token": "FTynRk_gwUPCwM9z0gykqp5USH8BLcxQgQmEiFYgtGM",
"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": "2026-01-01T13:02:24.463213Z",
"updated_at": "2026-01-02T13:02:24.467603Z",
"status": "active"
},
{"id": 72,
"first_name": "Jane",
"last_name": "Smith",
"email": "jane.smith@test.com",
"department": "Finance Accounting",
"created_at": "2025-12-31T13:02:24.460534Z",
"updated_at": "2026-01-02T13:02:24.461399Z",
"status": "pending"
},
{"id": 71,
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@test.com",
"department": "Human Resources",
"created_at": "2025-12-30T13:02:24.457621Z",
"updated_at": "2026-01-02T13:02:24.458567Z",
"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": "2026-01-01T13:02:24.699783Z",
"role": "owner",
"is_invitation_accepted": true
},
{"id": 187,
"first_name": "Jane",
"last_name": "Smith",
"email": "jane.smith@test.com",
"last_active_at": "2025-12-31T13:02:24.702270Z",
"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": "2026-01-02T13:02:25.132240Z",
"updated_at": "2026-01-02T13:02:25.132240Z",
"employees_count": 0,
"status": "draft",
"address": {"id": 12,
"street_name": "123 Market Street",
"city": "San Francisco",
"state_province": "California",
"zip_code": "94103",
"created_at": "2026-01-02T13:02:25.135528Z",
"updated_at": "2026-01-02T13:02:25.135528Z"
},
"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": "karlyn.dare@tillman-nienow.test",
"primary_contact_name": null,
"created_at": "2026-01-02T13:02:25.695462Z",
"employees_count": 0,
"status": "draft",
"subscription": null
},
{"id": 213,
"name": "Healthcare Plus",
"industry": "healthcare",
"primary_contact_email": "lionel.ullrich@bradtke.test",
"primary_contact_name": null,
"created_at": "2026-01-01T13:02:25.691258Z",
"employees_count": 0,
"status": "draft",
"subscription": null
},
{"id": 212,
"name": "Acme Corporation",
"industry": "technology",
"primary_contact_email": "clifton_grimes@daugherty.test",
"primary_contact_name": null,
"created_at": "2025-12-31T13:02:25.686529Z",
"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": "Heaney-Haag 131",
"declared_number_of_seats": 10,
"industry": "technology",
"primary_contact_email": "danyel@ratke.example",
"primary_contact_name": null,
"created_at": "2026-01-02T13:02:25.867351Z",
"updated_at": "2026-01-02T13:02:25.879554Z",
"employees_count": 0,
"status": "draft",
"address": {"id": 49,
"street_name": "Cummings Village",
"city": "South Elvinbury",
"state_province": "Michigan",
"zip_code": "07123-1708",
"created_at": "2026-01-02T13:02:25.869367Z",
"updated_at": "2026-01-02T13:02:25.869367Z"
},
"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": "Nienow LLC 140",
"declared_number_of_seats": 10,
"industry": "technology",
"primary_contact_email": "hyon_ziemann@langworth-oberbrunner.example",
"primary_contact_name": null,
"created_at": "2026-01-02T13:02:26.100616Z",
"updated_at": "2026-01-02T13:02:26.100616Z",
"employees_count": 0,
"status": "draft",
"address": {"id": 57,
"street_name": "Smith Gateway",
"city": "North Jodiburgh",
"state_province": "Ohio",
"zip_code": "60684-0541",
"created_at": "2026-01-02T13:02:26.102886Z",
"updated_at": "2026-01-02T13:02:26.102886Z"
},
"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": "2026-01-02T13:02:26.272421Z",
"updated_at": "2026-01-02T13:02:26.283420Z",
"employees_count": 0,
"status": "draft",
"address": {"id": 62,
"street_name": "123 Market Street",
"city": "San Francisco",
"state_province": "California",
"zip_code": "94103",
"created_at": "2026-01-02T13:02:26.274557Z",
"updated_at": "2026-01-02T13:02:26.274557Z"
},
"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": "Genoveva Kautzer",
"last_name": "Ed Nolan",
"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": "_rxVQ7jltJpWjwMZX7rphwZiS0zH5ZZqd6jhVHsjTTo",
"token_type": "Bearer",
"expires_in": 900,
"refresh_token": "OKVtmuO3lDNp_xFo4C2HwesgyJiuG060krxmPO8iVm4",
"scope": "caily_admin",
"created_at": 1728561600,
"user": {"id": 144,
"first_name": "Joanne Ondricka",
"last_name": "Marshall Hane",
"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:0x00007fbcb6543588>"
}

Response samples

201
401
403
404
422

Content type

application/json

{"id": 17,
"name": "example-pdf20260102-82-9muz91.pdf",
"size": 0,
"file_url": "http://minio:9000/caily-private/private_store/toolkit_file/17/example-pdf20260102-82-9muz91-17.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=minioadmin%2F20260102%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20260102T130227Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=bdfd6765f282e9f0311f425da15d925a1f204f92db08a42a54625e6d53fc1a62"
}

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%2F20260102%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20260102T130227Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=2801a577f275a91ffa1f2755f827120784a6879ba30401fc5a637ab6af5e53af"
},
{"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%2F20260102%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20260102T130227Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=2801a577f275a91ffa1f2755f827120784a6879ba30401fc5a637ab6af5e53af"
},
{"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%2F20260102%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20260102T130227Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=2801a577f275a91ffa1f2755f827120784a6879ba30401fc5a637ab6af5e53af"
},
{"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%2F20260102%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20260102T130227Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=2801a577f275a91ffa1f2755f827120784a6879ba30401fc5a637ab6af5e53af"
}
],
"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": "2026-01-02T14:02:28.593577Z",
"ends_at": "2026-01-02T15:02:28.593589Z",
"completed": false,
"location": null,
"notes": null,
"assignee": null,
"periodic_event": {"id": 7,
"created_at": "2026-01-02T13:02:28.591750Z",
"event_type": "event",
"name": "iusto",
"notes": "Hic et cupiditate recusandae.",
"is_private": false,
"alarm_before_minutes": null,
"is_all_day": false,
"location": null,
"periodicity_type": "interval",
"periodicity_dow": null,
"periodicity_interval": "daily",
"start_date": "2026-01-02",
"end_date": "2026-01-02",
"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": "2026-01-02T14:02:28.000000Z",
"ends_at": "2026-01-02T15:02:28.000000Z",
"completed": false,
"location": {"place_id": "ChIJN1t_tDeuEmsRUsoyG83frY4",
"name": "Googleplex"
},
"notes": "Updated notes",
"assignee": null,
"periodic_event": {"id": 13,
"created_at": "2026-01-02T13:02:28.896261Z",
"event_type": "event",
"name": "nobis",
"notes": "Minima doloremque odit rerum.",
"is_private": false,
"alarm_before_minutes": null,
"is_all_day": false,
"location": null,
"periodicity_type": "interval",
"periodicity_dow": null,
"periodicity_interval": "daily",
"start_date": "2026-01-02",
"end_date": "2026-01-02",
"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": "2026-01-02T14:02:29.000000Z",
"ends_at": "2026-01-02T14:17:29.000000Z",
"completed": false,
"location": null,
"notes": "Updated notes",
"assignee": null,
"periodic_event": {"id": 24,
"created_at": "2026-01-02T13:02:29.427595Z",
"event_type": "habit",
"name": "suscipit",
"notes": "Facere dolores cupiditate est.",
"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": "2026-01-01",
"end_date": "2026-01-01",
"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": "2026-01-02T14:02:30.000000Z",
"ends_at": "2026-01-02T14:17:30.000000Z",
"completed": false,
"location": null,
"notes": "Updated notes",
"assignee": null,
"periodic_event": {"id": 34,
"created_at": "2026-01-02T13:02:29.976844Z",
"event_type": "medication",
"name": "hic",
"notes": "Repellendus expedita at libero.",
"is_private": false,
"alarm_before_minutes": null,
"is_all_day": false,
"location": null,
"periodicity_type": "interval",
"periodicity_dow": null,
"periodicity_interval": "daily",
"start_date": "2026-01-01",
"end_date": "2026-01-01",
"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": "2026-01-02T14:02:30.472115Z",
"ends_at": "2026-01-02T15:02:30.472132Z",
"completed": true,
"location": null,
"notes": null,
"assignee": null,
"periodic_event": {"id": 43,
"created_at": "2026-01-02T13:02:30.467254Z",
"event_type": "task",
"name": "sit",
"notes": "Eum eveniet cum commodi.",
"is_private": false,
"alarm_before_minutes": null,
"is_all_day": false,
"location": null,
"periodicity_type": "interval",
"periodicity_dow": null,
"periodicity_interval": "daily",
"start_date": "2026-01-02",
"end_date": "2026-01-02",
"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": "Beahan-Altenwerth",
"address": "834 Langosh Spur Lake Harris South Dakota 02106 GP",
"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%2F20260102%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20260102T130231Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=d93e72812d0ebdc579a8e65ec100a357574eb1cd1d93dc096c64b9a2bd6360d4",
"created_at": "2026-01-02T13:02:31.526344Z",
"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": "2026-01-02T13:02:32.389184Z",
"chat_user_id": 15,
"user_id": 223,
"sender_name": "Denice Beahan Peter Effertz",
"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": "2026-01-02T13:02:33.380561Z",
"chat_user_id": 27,
"user_id": 246,
"sender_name": "Tamisha Kuhic Michel Blick",
"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": "2026-01-02T13:02:33.378111Z",
"chat_user_id": 27,
"user_id": 246,
"sender_name": "Tamisha Kuhic Michel Blick",
"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": "2026-01-02T13:02:33.667408Z",
"last_message": "Seth Doyle Donetta Weimann added Rev. Andrew Stracke Dane D'Amore to the chat",
"last_message_type": "system",
"created_at": "2026-01-02T13:02:33.631897Z",
"updated_at": "2026-01-02T13:02:33.631897Z",
"active_users_count": 2,
"members": [{"id": 32,
"chat_id": 34,
"user_id": 257,
"active": true,
"muted": false,
"last_seen_at": null,
"created_at": "2026-01-02T13:02:33.634711Z",
"updated_at": "2026-01-02T13:02:33.634711Z",
"user_first_name": "Seth Doyle",
"user_last_name": "Donetta Weimann",
"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": "2026-01-02T13:02:33.664834Z",
"updated_at": "2026-01-02T13:02:33.664834Z",
"user_first_name": "Rev. Andrew Stracke",
"user_last_name": "Dane D'Amore",
"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": "2026-01-02T13:02:34.237817Z",
"last_message": "Jeremy Denesik Jr. Ms. Giuseppe Kovacek removed Leana Fisher Lonnie Bartell from the chat",
"last_message_type": "system",
"created_at": "2026-01-02T13:02:34.212319Z",
"updated_at": "2026-01-02T13:02:34.212319Z",
"active_users_count": 1,
"members": [{"id": 45,
"chat_id": 45,
"user_id": 290,
"active": true,
"muted": false,
"last_seen_at": null,
"created_at": "2026-01-02T13:02:34.214336Z",
"updated_at": "2026-01-02T13:02:34.214336Z",
"user_first_name": "Jeremy Denesik Jr.",
"user_last_name": "Ms. Giuseppe Kovacek",
"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": "2026-01-02T13:02:34.569457Z",
"updated_at": "2026-01-02T13:02:34.579543Z",
"user_first_name": "Rosy Mueller",
"user_last_name": "Lita Jacobs",
"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": "2026-01-02T12:02:34.852164Z",
"last_message": null,
"last_message_type": null,
"created_at": "2026-01-02T13:02:34.852423Z",
"updated_at": "2026-01-02T13:02:34.852423Z",
"active_users_count": 1,
"members": [{"id": 66,
"chat_id": 61,
"user_id": 328,
"active": true,
"muted": false,
"last_seen_at": null,
"created_at": "2026-01-02T13:02:34.854790Z",
"updated_at": "2026-01-02T13:02:34.854790Z",
"user_first_name": "Jessi Will",
"user_last_name": "Ms. Valentin Hirthe",
"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": "2026-01-02T12:02:35.086299Z",
"last_message": null,
"last_message_type": null,
"created_at": "2026-01-02T13:02:35.086541Z",
"updated_at": "2026-01-02T13:02:35.086541Z",
"active_users_count": 1,
"members": [{"id": 71,
"chat_id": 66,
"user_id": 338,
"active": true,
"muted": false,
"last_seen_at": null,
"created_at": "2026-01-02T13:02:35.088664Z",
"updated_at": "2026-01-02T13:02:35.088664Z",
"user_first_name": "Mavis Block",
"user_last_name": "Charmaine Mills",
"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": "Mariana Zulauf",
"last_name": "The Hon. Terrie Reilly",
"user_email": "user366@example.com",
"avatar_url": null,
"created_at": "2026-01-02T13:02:35.868590Z",
"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": "Audie Lehner",
"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": "Solomon Roberts",
"last_name": "Deon Hammes",
"email": "user462@example.com",
"birthday": "1994-04-13",
"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": "Kasey Kertzmann",
"last_name": "Berry Watsica",
"email": "user474@example.com",
"birthday": "1978-01-28",
"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": "Tina Altenwerth",
"last_name": "Kerstin Stamm",
"email": "user434@example.com",
"birthday": "1992-08-12",
"roles": ["caregiver"
],
"placeholder_avatar_data": {"initials": "FF",
"background_color": "#FF0000"
}
},
{"id": 435,
"membership_id": 305,
"avatar_url": null,
"first_name": "Abbey Labadie II",
"last_name": "Dovie Schmidt",
"email": "user435@example.com",
"birthday": "1963-10-06",
"roles": ["admin"
],
"placeholder_avatar_data": {"initials": "FF",
"background_color": "#FF0000"
}
},
{"id": 436,
"membership_id": 306,
"avatar_url": null,
"first_name": "Dr. Emelda Ernser",
"last_name": "Robert Trantow",
"email": "user436@example.com",
"birthday": "1963-11-23",
"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": "Hank Morissette DC",
"last_name": "Enda Runolfsdottir",
"avatar_url": null,
"created_at": "2026-01-02T13:02:38.529654Z",
"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": "quas"
},
"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": "544 Brain Camp Rachalfurt Arizona 54204-9337 CN",
"oauth_redirect_url": "https://example.com/oauth/authorize",
"care_facility": {"id": 8,
"name": "Care Facility 1"
},
"updated_at": "2026-01-02T13:02:40.308113Z"
}
]

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": 1,
"name": "Elwood Yundt",
"email": "sherril@anderson-padberg.example",
"phone_number": null,
"notes": "Ut vitae nobis voluptates.",
"category": null
},
{"id": 3,
"name": "Wilbur Effertz",
"email": "raleigh_pfannerstill@littel-lakin.test",
"phone_number": null,
"notes": "Temporibus numquam necessitatibus est.",
"category": null
},
{"id": 2,
"name": "Winston Huels",
"email": "ana@farrell.example",
"phone_number": null,
"notes": "Qui aut similique magnam.",
"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-image20260102-82-bllil2-305.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=minioadmin%2F20260102%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20260102T130241Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=577125083dec1aeaa4f2ed6e39388c2028d21599ec0f03fe25ee3fd212255187",
"placeholder_avatar_data": {"initials": "PP",
"background_color": "#3C5322"
},
"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": "Gary Corwin",
"invitation_code": "FB5D39",
"patient_first_name": "Carey Hayes",
"patient_last_name": "Chet Bins",
"patient_email": "johnson.gerhold@wilderman.example",
"patient_birthday": "1987-11-10",
"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": "unde",
"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": "Melany McGlynn",
"invitation_code": "F30324",
"patient_first_name": "Alberta Miller",
"patient_last_name": "Queenie McKenzie",
"patient_email": "tameika@will.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": "4010C8",
"patient_first_name": "John",
"patient_last_name": "Doe",
"patient_email": "julieta.dietrich@kirlin-simonis.test",
"patient_birthday": "1990-01-01",
"patient_time_zone": "America/New_York",
"avatar_url": "http://minio:9000/caily-private/private_store/circle/409/example-image20260102-82-tcvp74-409.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=minioadmin%2F20260102%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20260102T130245Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=fbbd609e2fdf24527bb8a8d7f137bcd7341b7c271f598744f9d2e1605a5b5d82",
"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": "residences",
"vault_form_response_id": null
},
{"id": 2,
"name": "xyz",
"description": null,
"category_key": "healthcare_records",
"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": "2026-01-02T13:02:57.139168Z",
"updated_at": "2026-01-02T13:02:57.139168Z"
}

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": "2026-01-02T13:02:57.731375Z",
"updated_at": "2026-01-02T13:02:57.769750Z"
}

[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": "2026-01-02T13:03:14.235085Z",
"updated_at": "2026-01-02T13:03:14.235085Z"
}

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": "2026-01-02T13:03:14.805744Z",
"updated_at": "2026-01-02T13:03:14.805744Z"
}

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": "2026-01-02T13:03:15.042051Z",
"updated_at": "2026-01-02T13:03:15.076727Z"
}

[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%2F20260102%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20260102T130247Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=7701196fdbbfbd50925e71a556ba7a765ccb45f20b1ed35125429c3c30673af6",
"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%2F20260102%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20260102T130247Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=7701196fdbbfbd50925e71a556ba7a765ccb45f20b1ed35125429c3c30673af6",
"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": "2026-01-02"
}

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": "2026-01-01"
}

[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": "2026-01-02T13:02:49.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": "2026-01-01T18:07:08.856643Z",
"independence_level": "supervision"
}

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": "2026-01-02T13:02:50.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": "e471c5a3478eb8be534ef76bd5257241"
}

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": "nulla",
"hint": null
},
{"id": 2,
"name": "nihil",
"hint": null
},
{"id": 3,
"name": "omnis",
"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": "Thersa Stokes LLD",
"user_last_name": "Asia Hintz",
"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:0x00007fbcc0712f80>",
      "name": "pdf-document.pdf"
    }
  ]
}

Response samples

201
401
403
404
422

Content type

application/json

{"id": 53,
"created_at": "2026-01-02T13:02:51.567722Z",
"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": "2026-01-04",
"end_date": "2026-01-04",
"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": "Mario Murray Geraldo Kassulke",
"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-pdf20260102-82-ao57d4-1.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=minioadmin%2F20260102%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20260102T130251Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=e191a1fdd2a8be6e5d62fb973a3dda6172220e2e9df7d418634a48e1a09ac87f"
}
]
}

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": "2026-01-02T13:02:52.186751Z",
"name": "maiores",
"days_of_week": "Su",
"start_hour": "10:00",
"time_zone": "UTC",
"assignee": {"id": 1018,
"full_name": "Dona Auer Lin Hagenes Ret.",
"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": "2026-01-02T13:02:52.561265Z",
"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": "2026-01-01",
"end_date": "2026-01-01",
"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": "Amb. Sudie Bergstrom Willie Deckow",
"avatar_url": null,
"placeholder_avatar_data": {"initials": "FF",
"background_color": "#FF0000"
}
},
"task": {"id": 83,
"name": "inventore",
"starts_at": "2026-01-02T14:02:53.473093Z",
"assignee": null
},
"created_at": "2026-01-02T13:02:53.493706Z"
}

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

Destroy all

Authorizations:

Bearer Token

Responses

Response samples

401

Content type

application/json

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

Destroy

Authorizations:

Bearer Token

path Parameters

id

required

integer

Responses

Response samples

401
403
404

Content type

application/json

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

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": 14,
"created_at": "2026-01-01T00:00:00.000000Z",
"title": "Et enim sunt sint.",
"body": "Nisi nam qui. Quas alias est. Debitis eum corporis.",
"is_read": false,
"notification_type": "new_vault_task",
"notification_group": "system",
"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": {"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": 23,
"created_at": "2026-01-02T13:02:54.305143Z",
"title": "Id voluptas porro et.",
"body": "Officiis totam et. Sint quasi deleniti. Aliquid minus architecto.",
"is_read": true,
"notification_type": "task_alert",
"notification_group": "events",
"redirect_destination": "task",
"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": "Homenick, Volkman and Collier"
},
"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%2F20260102%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20260102T130254Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=dad03958c12f0b653a13a3de166769a4094811dfe470b5c5b099a64ae217b7e4"
}
]
}

[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:0x00007fbcc01799c0>"
}

Response samples

201
401
403
404
422

Content type

application/json

{"id": 98,
"created_at": "2026-01-02T13:02:55.238128Z",
"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": "2026-01-02",
"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": 1156,
"full_name": "The Hon. Kathrine Towne Gilma West",
"avatar_url": null,
"placeholder_avatar_data": {"initials": "FF",
"background_color": "#FF0000"
}
},
"vault_content_calendar_display": null,
"files": [{"id": 3,
"name": "example-image20260102-82-kuekil.png",
"size": 0,
"file_url": "http://minio:9000/caily-private/private_store/periodic_event_file/3/example-image20260102-82-kuekil-3.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=minioadmin%2F20260102%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20260102T130255Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=b5c7c0ce4830c09223b34171e77bab573ce0fa8e28edd11574a0a2b23ad1db9e"
}
]
}

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": "2026-01-02T13:02:55.879364Z",
"event_type": "medication",
"name": "impedit",
"notes": "Pariatur ducimus officiis perspiciatis.",
"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": "2026-01-01",
"end_date": "2026-01-01",
"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-image20260102-82-8z3p2p.png",
"size": 0,
"file_url": "http://minio:9000/caily-private/private_store/periodic_event_file/5/example-image20260102-82-8z3p2p-5.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=minioadmin%2F20260102%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20260102T130255Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=0258da48cf78a6db195b3035b9ef60ea8b2f3a395ff75d4da21a60b466577475"
}
]
}

[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:0x00007fbcbff9bd10>",
  "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-pdf20260102-82-watsk-1.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=minioadmin%2F20260102%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20260102T130256Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=2f9271db5a0171366321becb39951ca72d4a4d4d0898fc9b0bebdfd35b83d850"
}

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": "Darcel Grady Pasquale Batz LLD",
"feature_permissions": [{"id": 478,
"feature_type": null,
"permission_type": "edit",
"user_id": 1293,
"user_email": "user1293@example.com",
"user_first_name": "Darcel Grady",
"user_last_name": "Pasquale Batz LLD",
"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": 1295,
"user_email": "user1295@example.com",
"user_first_name": "Mack Graham Esq.",
"user_last_name": "Deidre Mayert",
"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": "eum",
"content": "Nisi mollitia aspernatur. Culpa commodi est. Incidunt sit ut.",
"note_folder_name": "voluptas",
"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%2F20260102%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20260102T130258Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=7c0f78f2362b7d52ed2d1d0128c9449be05e3b0a8bee3fe9dbfe598b78b1dcd4"
}
],
"created_by": "Travis Schulist DC Lisha Sipes",
"feature_permissions": [{"id": 492,
"feature_type": null,
"permission_type": "edit",
"user_id": 1332,
"user_email": "user1332@example.com",
"user_first_name": "Fr. Wendi Kertzmann",
"user_last_name": "Robt Kozey",
"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": "Taylor Ruecker Berry Jenkins",
"feature_permissions": [{"id": 498,
"feature_type": null,
"permission_type": "edit",
"user_id": 1350,
"user_email": "user1350@example.com",
"user_first_name": "Penny Donnelly",
"user_last_name": "Erich Bogisich",
"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": "Reinger Inc 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:0x00007fbcbf2c6a90>",
  "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-pdf20260102-82-7c5del-7.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=minioadmin%2F20260102%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20260102T130300Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=3a6befccceb47f5abb3fe2906e58a21383237ae77bae5a06983df497ff069f34"
}

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:0x00007fbcb61598f0>",
      "name": "pdf-document.pdf"
    }
  ]
}

Response samples

201
401
403
404
422

Content type

application/json

{"id": 136,
"created_at": "2026-01-02T13:03:00.717238Z",
"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": "2026-01-02",
"end_date": "2026-01-02",
"start_hour": "14:00",
"end_hour": "15:00",
"hours": null,
"time_zone": "UTC",
"series_end_date": "2026-02-02",
"dosage": null,
"vital_sign_measurement_type": null,
"adl_type": null,
"assignee": {"id": 1414,
"full_name": "Aisha Daniel DO Georgianna Schmidt",
"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-pdf20260102-82-tz314x-14.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=minioadmin%2F20260102%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20260102T130300Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=a4bcd6fff5eabf69b120f0b221132439aaf098cdbdc3f2ada4909e4198652f1e"
}
]
}

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": "2026-01-02T13:03:01.894012Z",
"event_type": "event",
"name": "quia",
"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": 1466,
"full_name": "Velma Conroy Jordon Howe Jr.",
"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%2F20260102%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20260102T130301Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=31826ac85f59d61a0b23cbd6f8d4bdf1ff9bc82310394ae132ebaa520026fb91",
"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": "2026-01-02T13:03:02.375630Z",
"event_type": "event",
"name": "ipsam",
"notes": "Veritatis dolor temporibus saepe.",
"is_private": false,
"alarm_before_minutes": null,
"is_all_day": false,
"location": null,
"periodicity_type": "interval",
"periodicity_dow": null,
"periodicity_interval": "daily",
"start_date": "2026-01-02",
"end_date": "2026-01-02",
"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": "2026-01-02T13:03:02.652301Z",
"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": "2026-01-02",
"end_date": "2026-01-02",
"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": "Dante Heathcote",
"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%2F20260102%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20260102T130303Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=1a045834f00e778713683110bfdbabb6beb776b15b4d8970894b9b7a0db04f06",
"placeholder_avatar_data": {"initials": "FF",
"background_color": "#FF0000"
},
"circle_role": "patient"
},
{"id": 45,
"circle_id": 807,
"circle_name": "The Hon. Margrett Swaniawski",
"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%2F20260102%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20260102T130303Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=1a045834f00e778713683110bfdbabb6beb776b15b4d8970894b9b7a0db04f06",
"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": "Antone Medhurst I",
"members_count": 0,
"avatar_url": null,
"placeholder_avatar_data": {"initials": "JD",
"background_color": "#000000"
}
},
{"id": 37,
"circle_id": 811,
"circle_name": "Refugia Halvorson",
"members_count": 0,
"avatar_url": null,
"placeholder_avatar_data": {"initials": "JD",
"background_color": "#000000"
}
},
{"id": 38,
"circle_id": 812,
"circle_name": "Duane Mitchell",
"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": "Gordon Boyle",
"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": 1590,
"first_name": "Almeda Stark",
"last_name": "Antoine Smitham",
"email": "user1588@example.com",
"phone_number": null,
"birthday": "1998-01-05",
"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:0x00007fbcb6699608>",
  "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": 1597,
"first_name": "John",
"last_name": "Doe",
"email": "user1595@example.com",
"phone_number": {"code": "+1",
"number": "(555) 123-4567"
},
"birthday": "1985-05-03",
"avatar_url": "http://minio:9000/caily-private/private_store/user/1597/example-image20260102-82-11re70-1597.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=minioadmin%2F20260102%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20260102T130304Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=397b1cd569f6e255a6135751f5216be7b245f4c0e2053708b9a214321459c950",
"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": "#904110"
},
"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": "Keebler Group 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": "ZatJewpoeSYDFCsHA_FC8ldz1rErLuzeGPfB8V8jK4k",
"token_type": "Bearer",
"expires_in": 300,
"created_at": 1767358984,
"scope": "health",
"refresh_token": "KYM1UeNgnj5vv5DW0R-dFmyvUwU3prDKjxlsjbihcts"
}

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-02-02T13:03:04.579159Z",
"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": "app_store",
"external_package_id": "4086267920",
"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": 2042,
"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": 2043,
"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": 2044,
"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": 2045,
"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": 2046,
"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": 2047,
"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": 2065,
"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": 2048,
"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": 2049,
"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": 2050,
"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": 2051,
"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": 2052,
"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": 2053,
"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": 2055,
"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": 2054,
"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": 2056,
"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": 2057,
"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": 2058,
"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": 2059,
"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": 2060,
"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": 2061,
"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": 2062,
"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": 2063,
"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": 2064,
"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": 2092,
"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": 2091,
"notification_type": "new_circle_invitation",
"notification_type_label": "New circle invitation",
"notification_group": "events",
"notification_group_label": "Events",
"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": "0yedkCn_0owIgFITPcVnJUrbnHXn7rDVE9Lq-etOSME",
"token_type": "Bearer",
"expires_in": 900,
"created_at": 1767358992,
"refresh_token": "MkOHR9igKrh-xOVgrJdrsXxTBAJ4YfjAyTAjJe-6tc8",
"user": {"id": 1904,
"first_name": "Kathlyn Swaniawski",
"last_name": "Isaac Stark",
"email": "new@example.com",
"phone_number": null,
"birthday": "2001-07-09",
"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": "2nsm6Rpf31dblv4kMaeIg6h-xIs2QQsAFyl4G-h24Mk",
"token_type": "Bearer",
"expires_in": 900,
"created_at": 1767358992,
"refresh_token": "NaLE7QhMd8Qk1tGFo77Tsb2SDe7G28Ptf6_s9qLjjsA",
"user": {"id": 1907,
"first_name": "Deloras Gleichner",
"last_name": "Dr. Roman Greenfelder",
"email": "user1900@example.com",
"phone_number": null,
"birthday": "1990-05-18",
"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": 1910,
"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": "#3C5322",
"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": "q_eCaQxZ_mAXt5UOeRJNnt708dvX2fycCqfx_5I1_Rc",
"token_type": "Bearer",
"expires_in": 900,
"refresh_token": "5mR9qltCmArWxCudZJyOP3mHGhANagtgHFQJXpq3PZg",
"scope": "web",
"created_at": 1728561600,
"user": {"id": 1611,
"first_name": "Adan Sporer",
"last_name": "Aron Lehner",
"email": "user1608@example.com",
"phone_number": null,
"birthday": "1990-10-29",
"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": "2026-01-09T13:03:05.530097Z",
"cancel_at": "2026-01-09T13:03:05.530097Z",
"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": "2026-01-09T13:03:05.530097Z"
}

[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": "2026-01-02T13:03:05.669000Z",
"severity": 3,
"lasted_for": "1 hour",
"notes": "Some notes",
"created_at": "2026-01-02T13:03:05.689495Z"
}

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": "2026-01-04T13:03:06.909333Z",
"severity": 1,
"lasted_for": "2 hours",
"notes": "Some notes",
"created_at": "2026-01-02T13:03:06.915045Z"
},
{"id": 17,
"circle_symptom": {"id": 36,
"symptom": null,
"name": null
},
"occurrence_time": "2026-01-03T13:03:06.909333Z",
"severity": 3,
"lasted_for": "2 hours",
"notes": "Some notes",
"created_at": "2026-01-02T13:03:06.911639Z"
},
{"id": 16,
"circle_symptom": {"id": 36,
"symptom": null,
"name": null
},
"occurrence_time": "2026-01-02T13:03:06.909333Z",
"severity": 0,
"lasted_for": "2 hours",
"notes": "Some notes",
"created_at": "2026-01-02T13:03:06.910044Z"
}
]

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": "2026-01-02T00:00:00.000000Z",
"severity": 5,
"lasted_for": "2 hours",
"notes": "Some notes",
"created_at": "2026-01-02T13:03:07.260470Z"
}

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": "2026-01-02T13:03:07.878000Z",
"severity": 1,
"lasted_for": "1 hour",
"notes": "Some notes",
"created_at": "2026-01-02T13:03:07.864960Z"
}

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-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
}
},
{"table": {"month": "2026-01",
"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:0x00007fbcb6c98130>",
      "name": "pdf-document.pdf"
    }
  ],
  "help_request_id": 1
}

Response samples

201
401
403
404
422

Content type

application/json

{"id": 178,
"created_at": "2026-01-02T13:03:08.232571Z",
"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": "2026-01-02",
"end_date": "2026-01-02",
"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": 1727,
"full_name": "Logan Spencer Harry Kuhic",
"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-pdf20260102-82-zh8fr3-16.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=minioadmin%2F20260102%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20260102T130308Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=512944a84bbe156765952b369d2146f7dd9d766dbbad2e2964e7fd74ab8a6def"
}
]
}

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": "2026-01-02T13:03:09.617283Z",
"event_type": "task",
"name": "explicabo",
"notes": "Libero ut id esse.",
"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": "2026-01-02",
"end_date": "2026-01-02",
"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:0x00007fbcb6e94510>",
      "name": "pdf-document.pdf"
    }
  ],
  "vault_content_calendar_display": true
}

Response samples

201
401
403
404
422

Content type

application/json

{"id": 210,
"created_at": "2026-01-02T13:03:10.219454Z",
"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": 1799,
"full_name": "Keneth Quitzon Lorita Dibbert",
"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-pdf20260102-82-ousnv8-18.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=minioadmin%2F20260102%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20260102T130310Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=279530beca26caf4b163629123c8e71bbc09201f89f3becd2fa933893e40694c"
}
]
}

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": "2026-01-02T13:03:12.026209Z",
"event_type": "event",
"name": "velit",
"notes": "Sunt minima dolorum nostrum.",
"is_private": false,
"alarm_before_minutes": null,
"is_all_day": false,
"location": null,
"periodicity_type": "interval",
"periodicity_dow": null,
"periodicity_interval": "daily",
"start_date": "2026-01-02",
"end_date": "2026-01-02",
"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": "2026-01-02T13:03:12.315625Z",
"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": "2026-01-02",
"end_date": "2026-01-02",
"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": "2026-01-02T13:03:11.291105Z",
"name": "eos",
"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": "2026-01-02T13:03:11.299149Z",
"name": "corporis",
"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-pdf20260102-82-xyodks-1.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=minioadmin%2F20260102%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20260102T130313Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=934c6307685706e0fb138e1b1bac2f55141a2c23625df3e3edb44dc226bcf1b3",
"created_at": "2026-01-02T13:03:13.231671Z",
"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%2F20260102%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20260102T130314Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=f707a87b9a0d78fc25cb75b07c00de5be33cfe4a43839b1b9196d6883b247d87",
"created_at": "2026-01-02T13:03:13.968957Z",
"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": "education",
"subcategories": [{"id": "personal_education_history",
"name": "Personal Education History",
"description": "The \"Personal Education History\" section organizes details about your academic journey, including schools attended, degrees earned, and certifications. It ensures easy access for career advancement, applications, and personal records.",
"can_duplicate": false,
"question_groups": [{"id": "schools_attended",
"name": "Schools Attended",
"questions": [{"id": "personal_edu_educational_institutions",
"label": "Educational Institutions",
"type": "text",
"description": "What are the names of the schools or institutions you attended? Include details for elementary, middle, high school, college, and graduate studies if applicable."
},
{"id": "personal_edu_attendance_dates",
"label": "Attendance Dates",
"type": "text",
"description": "What were the start and end dates for each institution?"
},
{"id": "personal_edu_educational_gaps",
"label": "Educational Gaps",
"type": "text",
"description": "Were there any gaps in attendance? If so, why?"
}
]
},
{"id": "degrees_or_certifications_earned",
"name": "Degrees or Certifications Earned",
"questions": [{"id": "personal_edu_degrees_or_certifications_earned",
"label": "Degrees or Certifications Earned",
"type": "text",
"description": "What degrees, diplomas, or certifications were earned at each institution? Include honors or special recognitions."
}
]
},
{"id": "field_of_study_if_applicable",
"name": "Field of Study (if applicable)",
"questions": [{"id": "personal_edu_field_of_study",
"label": "Field of Study",
"type": "text",
"description": "What was your major or area of focus for each degree?"
}
]
},
{"id": "extracurricular_activities",
"name": "Extracurricular Activities",
"questions": [{"id": "personal_edu_extracurricular_activities",
"label": "Extracurricular Activities",
"type": "text",
"description": "Were you involved in sports, clubs, or other activities during your education?"
}
]
},
{"id": "attachments",
"name": "Attachments",
"questions": [{"id": "personal_edu_attachments",
"label": "Attachments",
"type": "file",
"description": "Diplomas, transcripts, certifications, letters of recommendation, or awards."
}
]
}
]
},
{"id": "dependents_education",
"name": "Dependents' Education",
"description": "The \"Dependent's Education\" section tracks academic details for your dependents, including schools attended, grades, and special programs. It ensures organized records for planning, applications, and future educational needs.",
"can_duplicate": true,
"question_groups": [{"id": "schools_attended",
"name": "Schools Attended",
"questions": [{"id": "dependent_edu_educational_history",
"label": "Educational History",
"type": "text",
"description": "What schools are your dependents currently attending or have attended in the past? Include grade level or program type."
}
]
},
{"id": "dates_attended",
"name": "Dates Attended",
"questions": [{"id": "dependent_edu_dates_attended",
"label": "Dates Attended",
"type": "text",
"description": "What are the start and end dates for each institution your dependents attended?"
}
]
},
{"id": "current_grade_or_program",
"name": "Current Grade or Program",
"questions": [{"id": "dependent_edu_current_grade_or_program",
"label": "Current Grade or Program",
"type": "text",
"description": "What grade or academic program is your dependent enrolled in? (e.g., elementary school, college, trade school)"
}
]
},
{"id": "special_programs_or_accommodations",
"name": "Special Programs or Accommodations",
"questions": [{"id": "dependent_edu_special_programs_or_accommodations",
"label": "Special Programs or Accommodations",
"type": "text",
"description": "Are your dependents enrolled in any special education programs, honors courses, or extracurricular activities?"
}
]
},
{"id": "future_plans",
"name": "Future Plans",
"questions": [{"id": "dependent_edu_future_plans",
"label": "Future Plans",
"type": "text",
"description": "Are there specific schools, programs, or goals planned for your dependents' education?"
}
]
},
{"id": "attachments",
"name": "Attachments",
"questions": [{"id": "dependent_edu_attachments",
"label": "Attachments",
"type": "file",
"description": "School enrollment forms, progress reports, report cards, transcripts, awards, or participation certificates."
}
]
}
]
},
{"id": "education_savings",
"name": "Education Savings",
"description": "The \"Education Savings\" section organizes details of accounts set aside for educational expenses, such as 529 Plans or ESAs. It tracks contributions, balances, and beneficiaries to simplify financial planning for future education costs.",
"can_duplicate": true,
"question_groups": [{"id": "account_type",
"name": "Account Type",
"questions": [{"id": "edu_savings_account_type",
"label": "Account Type",
"type": "text",
"description": "What type of savings account do you have for educational purposes? (e.g., 529 Plan, Coverdell ESA, savings bonds)"
}
]
},
{"id": "account_holder",
"name": "Account Holder",
"questions": [{"id": "edu_savings_account_holder",
"label": "Account Holder",
"type": "text",
"description": "Who is the account holder? (e.g., parent, guardian, grandparent)"
}
]
},
{"id": "provider_name",
"name": "Provider Name",
"questions": [{"id": "edu_savings_provider_name",
"label": "Provider Name",
"type": "text",
"description": "What financial institution manages the account?"
}
]
},
{"id": "account_number",
"name": "Account Number",
"questions": [{"id": "edu_savings_account_number",
"label": "Account Number",
"type": "text",
"description": "What is the account number for the educational savings plan?"
}
]
},
{"id": "current_balance",
"name": "Current Balance",
"questions": [{"id": "edu_savings_current_balance",
"label": "Current Balance",
"type": "text",
"description": "What is the current balance of the account?"
}
]
},
{"id": "contributions",
"name": "Contributions",
"questions": [{"id": "edu_savings_contributions",
"label": "Contributions",
"type": "text",
"description": "How often do you contribute to the account, and in what amount? (e.g., monthly, annually)"
}
]
},
{"id": "withdrawal_rules",
"name": "Withdrawal Rules",
"questions": [{"id": "edu_savings_withdrawal_rules",
"label": "Withdrawal Rules",
"type": "text",
"description": "Are there restrictions or rules on withdrawals from the account?"
}
]
},
{"id": "beneficiary_information",
"name": "Beneficiary Information",
"questions": [{"id": "edu_savings_beneficiary_information",
"label": "Beneficiary Information",
"type": "text",
"description": "Who is the designated beneficiary of the savings plan?"
}
]
},
{"id": "future_projections",
"name": "Future Projections",
"questions": [{"id": "edu_savings_future_projections",
"label": "Future Projections",
"type": "text",
"description": "Is the account on track to meet educational expenses based on current contributions?"
}
]
},
{"id": "attachments",
"name": "Attachments",
"questions": [{"id": "edu_savings_attachments",
"label": "Attachments",
"type": "file",
"description": "Account statements, contribution records, and provider agreements"
}
]
}
]
},
{"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": "edu_other_additional_informations",
"label": "Additional informations",
"type": "text",
"description": "Informations"
},
{"id": "edu_other_attachments",
"label": "Attachments",
"type": "file",
"description": ""
}
]
}
]
}
]
}

[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": "2026-01-02T13:03:18.105000Z",
"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": "2026-01-02T13:03:18.789166Z",
"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": "2026-01-02T13:03:19.148000Z",
"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:0x00007fbcc94caf08>",
  "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-pdf20260102-82-2l6jxo-1767358999471-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": ["3696194843",
"5492490272"
]
},
{"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": ["1643416066",
"1868778431"
]
},
{"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": ["6525816767",
"3987452435"
]
}
]

[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"
}