How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Amigo Scheduling Rules API

The Scheduling Rules API from Amigo — 2 operation(s) for scheduling rules.

Amigo Scheduling Rules API is one of 72 APIs that Amigo publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Scheduling Rules. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 5 operations across 2 paths, and defines 13 schemas. It is described by OpenAPI 3.2.0, at version 0.1.0.

Requests are made against 5 base URLs: https://api.amigo.ai, https://internal-api.amigo.ai, https://api-eu-central-1.amigo.ai, https://api-ap-southeast-2.amigo.ai, https://api-ca-central-1.amigo.ai.

5 operations 2 paths 13 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
0.1.0
Base URL
https://api.amigo.ai
Authentication
HTTP Bearer, API Key, HTTP Basic
Resource Areas
1

Authentication & Security 3

Amigo Scheduling Rules API declares 3 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (Bearer-Authorization). An API key is passed in the header as X-ORG-ID (Bearer-Authorization-Organization). It accepts HTTP basic authentication (Basic). By default, every request must be authenticated.

  • Bearer-Authorization — Amigo issued JWT token that identifies an user. It's issued either after logging in through the frontend, or manually through the [SignInWithAPIKey](sign-in-wi…
  • Bearer-Authorization-Organization — An optional organization identifier that indicates from which organization the token is issued. This is used in rare cases where the user to authenticate is ma…
  • Basic — The username should be set to {orgid}{userid}, and the password should be the Amigo issued JWT token that identifies the user.

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Scheduling Rules 5
GET
/v1/{workspace_id}/scheduling-rule-sets
List scheduling rule sets
list-scheduling-rule-sets 5 params → 200403401429422
POST
/v1/{workspace_id}/scheduling-rule-sets
Create a scheduling rule set
create-scheduling-rule-set 1 param body → 201409422403401429
GET
/v1/{workspace_id}/scheduling-rule-sets/{rule_set_id}
Get one scheduling rule set
get-scheduling-rule-set 2 params → 200404403401429422
PATCH
/v1/{workspace_id}/scheduling-rule-sets/{rule_set_id}
Partially update a scheduling rule set
update-scheduling-rule-set 2 params body → 200404422403401429
DELETE
/v1/{workspace_id}/scheduling-rule-sets/{rule_set_id}
Delete a scheduling rule set
delete-scheduling-rule-set 2 params → 204404403401429422

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are ClinicOpenHoursParams (9 properties), SchedulingRuleSetResponse (9 properties), ValidationError (5 properties), PaginatedResponse_SchedulingRuleSetResponse_ (4 properties). Each schema is shown below with its type and property counts.

_DayHours
object
Open-hours window for one weekday. Times in 24h HH:MM form, interpreted in the rule set's timezone.
2 properties 2 required
CreateSchedulingRuleSetRequest
object
3 properties 2 required
UpdateSchedulingRuleSetRequest
object
Partial update — fields not provided are unchanged. params must be the full per-kind shape (no patch within params); send the whole RuleParams or omit.
2 properties
HTTPValidationError
object
1 property
KetamineBlockOverlapParams
object
How many days after a ketamine session to block follow-up appointments (clinical safety window).
2 properties 1 required
ValidationError
object
5 properties 3 required
TMSSessionGridParams
object
TMS sessions only start at fixed minute-of-hour boundaries (e.g. :00 and :30) so the technician can run them back-to-back without gaps.
3 properties 2 required
PaginatedResponse_SchedulingRuleSetResponse_
object
4 properties 2 required
TMSMappingReleaseParams
object
How long before a TMS mapping appointment its slot is released back to the pool. weekendskip=True adds Saturday + Sunday days to the wall-clock countdown (clin…
3 properties 1 required
SchedulingRuleSetResponse
object
Wire shape for a single rule set. params stays as dict here (not the discriminated union) so add-a-new-kind doesn't break older clients still on the previous S…
9 properties 9 required
ConcurrentStartBlockParams
object
Disallow two slots starting at the same time within a TMS scope. No additional params — the discriminator is the whole config.
1 property
ClinicOpenHoursParams
object
Workspace clinic open-hours by weekday. Days not present mean "closed." Used by the rules engine to skip slots outside open hours and (combined with weekendski…
9 properties 1 required
NinetyDayRollingParams
object
Rolling-window cap on appointments per patient (e.g. 90 days between TMS sessions).
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

amigo-scheduling-rules-api-openapi.yml Raw ↑

Other APIs Amigo publishes across the network.

Amigo Account API
Amigo Admin API
Amigo Agent Definitions API
Amigo Agent Runs API
Amigo Agents API
Amigo Analytics API
Amigo API Keys API
Amigo Audit API
Amigo Auth API
Amigo Billing API
Amigo Calls API
Amigo Command Center API
Where this information came from

This is an independent, third-party profile of Amigo Scheduling Rules API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.