Appearance
calendar
5 endpoints.
GET /api/v1/erp/my-calendar/staff
List Staff
The people a superuser can switch the calendar page to: active platform STAFF — is_internal or a superuser. Not a role test: a customer org's owner holds an admin role in their OWN tenant on this same users table, and the first cut listed every one of them. is_hidden is not filtered either — it hides the platform's own superusers from customer lists, and they are exactly whose calendars get looked at.
200 — Successful Response
json
{}GET /api/v1/erp/my-calendar
List Events
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
user_id | query | no | ||
start | query | no | ||
end | query | no |
200 — Successful Response
json
{}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}POST /api/v1/erp/my-calendar
Create Event
Request body
json
{
"properties": {
"title": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"title": "Title"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"start_at": {
"type": "string",
"format": "date-time",
"title": "Start At"
},
"end_at": {
"type": "string",
"format": "date-time",
"title": "End At"
},
"all_day": {
"type": "boolean",
"title": "All Day",
"default": false
},
"location": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Location"
},
"meeting_link": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Meeting Link"
},
"notes": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Notes"
},
"user_id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "User Id"
}
},
"type": "object",
"required": [
"title",
"start_at",
"end_at"
],
"title": "EventIn"
}201 — Successful Response
json
{}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}PATCH /api/v1/erp/my-calendar/{event_id}
Update Event
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
event_id | path | yes | integer |
Request body
json
{
"properties": {
"title": {
"anyOf": [
{
"type": "string",
"maxLength": 255,
"minLength": 1
},
{
"type": "null"
}
],
"title": "Title"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"start_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start At"
},
"end_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End At"
},
"all_day": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "All Day"
},
"location": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Location"
},
"meeting_link": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Meeting Link"
},
"notes": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Notes"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status"
}
},
"type": "object",
"title": "EventPatch"
}200 — Successful Response
json
{}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}DELETE /api/v1/erp/my-calendar/{event_id}
Delete Event
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
event_id | path | yes | integer |
200 — Successful Response
json
{}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}